Rekognition module#
Index > Rekognition
Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Rekognition
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Rekognition
.
From PyPI with pip#
Install boto3-stubs
for Rekognition
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[rekognition]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[rekognition]'
# standalone installation
python -m pip install mypy-boto3-rekognition
How to uninstall#
python -m pip uninstall -y mypy-boto3-rekognition
Usage#
Code samples can be found in Examples.
RekognitionClient#
Type annotations and code completion for boto3.client("rekognition")
as RekognitionClient
boto3 documentation
# RekognitionClient usage example
from boto3.session import Session
from mypy_boto3_rekognition.client import RekognitionClient
def get_client() -> RekognitionClient:
return Session().client("rekognition")
Paginators#
Type annotations and code completion for paginators
from boto3.client("rekognition").get_paginator("...")
.
# DescribeProjectVersionsPaginator usage example
from boto3.session import Session
from mypy_boto3_rekognition.paginator import DescribeProjectVersionsPaginator
def get_describe_project_versions_paginator() -> DescribeProjectVersionsPaginator:
return Session().client("rekognition").get_paginator("describe_project_versions"))
- DescribeProjectVersionsPaginator
- DescribeProjectsPaginator
- ListCollectionsPaginator
- ListDatasetEntriesPaginator
- ListDatasetLabelsPaginator
- ListFacesPaginator
- ListProjectPoliciesPaginator
- ListStreamProcessorsPaginator
- ListUsersPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("rekognition").get_waiter("...")
.
# ProjectVersionRunningWaiter usage example
from boto3.session import Session
from mypy_boto3_rekognition.waiter import ProjectVersionRunningWaiter
def get_project_version_running_waiter() -> ProjectVersionRunningWaiter:
return Session().client("rekognition").get_waiter("project_version_running")
Literals#
Type annotations for literals used in methods and schema.
# AttributeType usage example
from mypy_boto3_rekognition.literals import AttributeType
def get_value() -> AttributeType:
return "AGE_RANGE"
- AttributeType
- BodyPartType
- CelebrityRecognitionSortByType
- ContentClassifierType
- ContentModerationAggregateByType
- ContentModerationSortByType
- CustomizationFeatureType
- DatasetStatusMessageCodeType
- DatasetStatusType
- DatasetTypeType
- DescribeProjectVersionsPaginatorName
- DescribeProjectsPaginatorName
- DetectLabelsFeatureNameType
- EmotionNameType
- FaceAttributesType
- FaceSearchSortByType
- GenderTypeType
- KnownGenderTypeType
- LabelDetectionAggregateByType
- LabelDetectionFeatureNameType
- LabelDetectionSortByType
- LandmarkTypeType
- ListCollectionsPaginatorName
- ListDatasetEntriesPaginatorName
- ListDatasetLabelsPaginatorName
- ListFacesPaginatorName
- ListProjectPoliciesPaginatorName
- ListStreamProcessorsPaginatorName
- ListUsersPaginatorName
- LivenessSessionStatusType
- MediaAnalysisJobFailureCodeType
- MediaAnalysisJobStatusType
- OrientationCorrectionType
- PersonTrackingSortByType
- ProjectAutoUpdateType
- ProjectStatusType
- ProjectVersionRunningWaiterName
- ProjectVersionStatusType
- ProjectVersionTrainingCompletedWaiterName
- ProtectiveEquipmentTypeType
- QualityFilterType
- ReasonType
- SegmentTypeType
- StreamProcessorParameterToDeleteType
- StreamProcessorStatusType
- TechnicalCueTypeType
- TextTypesType
- UnsearchedFaceReasonType
- UnsuccessfulFaceAssociationReasonType
- UnsuccessfulFaceDeletionReasonType
- UnsuccessfulFaceDisassociationReasonType
- UserStatusType
- VideoColorRangeType
- VideoJobStatusType
- RekognitionServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AgeRangeTypeDef
- AssociateFacesRequestRequestTypeDef
- AssociatedFaceTypeDef
- ResponseMetadataTypeDef
- UnsuccessfulFaceAssociationTypeDef
- AudioMetadataTypeDef
- BoundingBoxTypeDef
- S3ObjectTypeDef
- BeardTypeDef
- BlackFrameTypeDef
- BlobTypeDef
- KnownGenderTypeDef
- EmotionTypeDef
- ImageQualityTypeDef
- LandmarkTypeDef
- PoseTypeDef
- SmileTypeDef
- ConnectedHomeSettingsForUpdateTypeDef
- ConnectedHomeSettingsOutputTypeDef
- ConnectedHomeSettingsTypeDef
- ContentTypeTypeDef
- ModerationLabelTypeDef
- OutputConfigTypeDef
- CoversBodyPartTypeDef
- CreateCollectionRequestRequestTypeDef
- LivenessOutputConfigTypeDef
- CreateProjectRequestRequestTypeDef
- StreamProcessorDataSharingPreferenceTypeDef
- StreamProcessorNotificationChannelTypeDef
- CreateUserRequestRequestTypeDef
- CustomizationFeatureContentModerationConfigTypeDef
- DatasetStatsTypeDef
- DatasetLabelStatsTypeDef
- DatasetMetadataTypeDef
- DeleteCollectionRequestRequestTypeDef
- DeleteDatasetRequestRequestTypeDef
- DeleteFacesRequestRequestTypeDef
- UnsuccessfulFaceDeletionTypeDef
- DeleteProjectPolicyRequestRequestTypeDef
- DeleteProjectRequestRequestTypeDef
- DeleteProjectVersionRequestRequestTypeDef
- DeleteStreamProcessorRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- DescribeCollectionRequestRequestTypeDef
- DescribeDatasetRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeProjectVersionsRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeProjectsRequestRequestTypeDef
- DescribeStreamProcessorRequestRequestTypeDef
- DetectLabelsImageQualityTypeDef
- DominantColorTypeDef
- DetectLabelsImagePropertiesSettingsTypeDef
- GeneralLabelsSettingsTypeDef
- HumanLoopActivationOutputTypeDef
- ProtectiveEquipmentSummarizationAttributesTypeDef
- ProtectiveEquipmentSummaryTypeDef
- DetectionFilterTypeDef
- DisassociateFacesRequestRequestTypeDef
- DisassociatedFaceTypeDef
- UnsuccessfulFaceDisassociationTypeDef
- DistributeDatasetTypeDef
- EyeDirectionTypeDef
- EyeOpenTypeDef
- EyeglassesTypeDef
- FaceOccludedTypeDef
- GenderTypeDef
- MouthOpenTypeDef
- MustacheTypeDef
- SunglassesTypeDef
- FaceSearchSettingsTypeDef
- PointTypeDef
- GetCelebrityInfoRequestRequestTypeDef
- GetCelebrityRecognitionRequestRequestTypeDef
- VideoMetadataTypeDef
- GetContentModerationRequestMetadataTypeDef
- GetContentModerationRequestRequestTypeDef
- GetFaceDetectionRequestRequestTypeDef
- GetFaceLivenessSessionResultsRequestRequestTypeDef
- GetFaceSearchRequestRequestTypeDef
- GetLabelDetectionRequestMetadataTypeDef
- GetLabelDetectionRequestRequestTypeDef
- GetMediaAnalysisJobRequestRequestTypeDef
- MediaAnalysisJobFailureDetailsTypeDef
- MediaAnalysisOutputConfigTypeDef
- GetPersonTrackingRequestRequestTypeDef
- GetSegmentDetectionRequestRequestTypeDef
- SegmentTypeInfoTypeDef
- GetTextDetectionRequestRequestTypeDef
- HumanLoopDataAttributesTypeDef
- KinesisDataStreamTypeDef
- KinesisVideoStreamStartSelectorTypeDef
- KinesisVideoStreamTypeDef
- LabelAliasTypeDef
- LabelCategoryTypeDef
- ParentTypeDef
- ListCollectionsRequestRequestTypeDef
- ListDatasetEntriesRequestRequestTypeDef
- ListDatasetLabelsRequestRequestTypeDef
- ListFacesRequestRequestTypeDef
- ListMediaAnalysisJobsRequestRequestTypeDef
- ListProjectPoliciesRequestRequestTypeDef
- ProjectPolicyTypeDef
- ListStreamProcessorsRequestRequestTypeDef
- StreamProcessorTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListUsersRequestRequestTypeDef
- UserTypeDef
- MatchedUserTypeDef
- MediaAnalysisDetectModerationLabelsConfigTypeDef
- MediaAnalysisModelVersionsTypeDef
- NotificationChannelTypeDef
- PutProjectPolicyRequestRequestTypeDef
- S3DestinationTypeDef
- SearchFacesRequestRequestTypeDef
- SearchUsersRequestRequestTypeDef
- SearchedFaceTypeDef
- SearchedUserTypeDef
- ShotSegmentTypeDef
- TechnicalCueSegmentTypeDef
- StartProjectVersionRequestRequestTypeDef
- StartShotDetectionFilterTypeDef
- StreamProcessingStopSelectorTypeDef
- StopProjectVersionRequestRequestTypeDef
- StopStreamProcessorRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- CopyProjectVersionResponseTypeDef
- CreateCollectionResponseTypeDef
- CreateDatasetResponseTypeDef
- CreateFaceLivenessSessionResponseTypeDef
- CreateProjectResponseTypeDef
- CreateProjectVersionResponseTypeDef
- CreateStreamProcessorResponseTypeDef
- DeleteCollectionResponseTypeDef
- DeleteProjectResponseTypeDef
- DeleteProjectVersionResponseTypeDef
- DescribeCollectionResponseTypeDef
- ListCollectionsResponseTypeDef
- ListDatasetEntriesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutProjectPolicyResponseTypeDef
- StartCelebrityRecognitionResponseTypeDef
- StartContentModerationResponseTypeDef
- StartFaceDetectionResponseTypeDef
- StartFaceSearchResponseTypeDef
- StartLabelDetectionResponseTypeDef
- StartMediaAnalysisJobResponseTypeDef
- StartPersonTrackingResponseTypeDef
- StartProjectVersionResponseTypeDef
- StartSegmentDetectionResponseTypeDef
- StartStreamProcessorResponseTypeDef
- StartTextDetectionResponseTypeDef
- StopProjectVersionResponseTypeDef
- AssociateFacesResponseTypeDef
- ComparedSourceImageFaceTypeDef
- FaceTypeDef
- AuditImageTypeDef
- GroundTruthManifestTypeDef
- MediaAnalysisInputTypeDef
- MediaAnalysisManifestSummaryTypeDef
- SummaryTypeDef
- VideoTypeDef
- StartTechnicalCueDetectionFilterTypeDef
- DatasetChangesTypeDef
- ImageTypeDef
- GetCelebrityInfoResponseTypeDef
- ComparedFaceTypeDef
- StreamProcessorSettingsForUpdateTypeDef
- ConnectedHomeSettingsUnionTypeDef
- ContentModerationDetectionTypeDef
- CopyProjectVersionRequestRequestTypeDef
- EquipmentDetectionTypeDef
- CreateFaceLivenessSessionRequestSettingsTypeDef
- CustomizationFeatureConfigTypeDef
- DatasetDescriptionTypeDef
- DatasetLabelDescriptionTypeDef
- ProjectDescriptionTypeDef
- DeleteFacesResponseTypeDef
- DescribeProjectVersionsRequestPaginateTypeDef
- DescribeProjectsRequestPaginateTypeDef
- ListCollectionsRequestPaginateTypeDef
- ListDatasetEntriesRequestPaginateTypeDef
- ListDatasetLabelsRequestPaginateTypeDef
- ListFacesRequestPaginateTypeDef
- ListProjectPoliciesRequestPaginateTypeDef
- ListStreamProcessorsRequestPaginateTypeDef
- ListUsersRequestPaginateTypeDef
- DescribeProjectVersionsRequestWaitTypeDef
- DetectLabelsImageBackgroundTypeDef
- DetectLabelsImageForegroundTypeDef
- InstanceTypeDef
- DetectLabelsSettingsTypeDef
- LabelDetectionSettingsTypeDef
- DetectModerationLabelsResponseTypeDef
- DisassociateFacesResponseTypeDef
- DistributeDatasetEntriesRequestRequestTypeDef
- FaceDetailTypeDef
- StreamProcessorSettingsOutputTypeDef
- GeometryTypeDef
- RegionOfInterestOutputTypeDef
- RegionOfInterestTypeDef
- HumanLoopConfigTypeDef
- StreamProcessingStartSelectorTypeDef
- StreamProcessorInputTypeDef
- ListProjectPoliciesResponseTypeDef
- ListStreamProcessorsResponseTypeDef
- ListUsersResponseTypeDef
- UserMatchTypeDef
- MediaAnalysisOperationsConfigTypeDef
- MediaAnalysisResultsTypeDef
- StreamProcessorOutputTypeDef
- SegmentDetectionTypeDef
- FaceMatchTypeDef
- ListFacesResponseTypeDef
- GetFaceLivenessSessionResultsResponseTypeDef
- AssetTypeDef
- DatasetSourceTypeDef
- EvaluationResultTypeDef
- StartCelebrityRecognitionRequestRequestTypeDef
- StartContentModerationRequestRequestTypeDef
- StartFaceDetectionRequestRequestTypeDef
- StartFaceSearchRequestRequestTypeDef
- StartPersonTrackingRequestRequestTypeDef
- StartSegmentDetectionFiltersTypeDef
- UpdateDatasetEntriesRequestRequestTypeDef
- CompareFacesRequestRequestTypeDef
- DetectCustomLabelsRequestRequestTypeDef
- DetectFacesRequestRequestTypeDef
- DetectProtectiveEquipmentRequestRequestTypeDef
- IndexFacesRequestRequestTypeDef
- RecognizeCelebritiesRequestRequestTypeDef
- SearchFacesByImageRequestRequestTypeDef
- SearchUsersByImageRequestRequestTypeDef
- CelebrityTypeDef
- CompareFacesMatchTypeDef
- StreamProcessorSettingsTypeDef
- GetContentModerationResponseTypeDef
- ProtectiveEquipmentBodyPartTypeDef
- CreateFaceLivenessSessionRequestRequestTypeDef
- DescribeDatasetResponseTypeDef
- ListDatasetLabelsResponseTypeDef
- DescribeProjectsResponseTypeDef
- DetectLabelsImagePropertiesTypeDef
- LabelTypeDef
- DetectLabelsRequestRequestTypeDef
- StartLabelDetectionRequestRequestTypeDef
- CelebrityDetailTypeDef
- DetectFacesResponseTypeDef
- FaceDetectionTypeDef
- FaceRecordTypeDef
- PersonDetailTypeDef
- SearchedFaceDetailsTypeDef
- UnindexedFaceTypeDef
- UnsearchedFaceTypeDef
- CustomLabelTypeDef
- TextDetectionTypeDef
- RegionOfInterestUnionTypeDef
- UpdateStreamProcessorRequestRequestTypeDef
- DetectModerationLabelsRequestRequestTypeDef
- StartStreamProcessorRequestRequestTypeDef
- SearchUsersResponseTypeDef
- StartMediaAnalysisJobRequestRequestTypeDef
- GetMediaAnalysisJobResponseTypeDef
- MediaAnalysisJobDescriptionTypeDef
- DescribeStreamProcessorResponseTypeDef
- GetSegmentDetectionResponseTypeDef
- SearchFacesByImageResponseTypeDef
- SearchFacesResponseTypeDef
- TestingDataOutputTypeDef
- TestingDataTypeDef
- TrainingDataOutputTypeDef
- TrainingDataTypeDef
- ValidationDataTypeDef
- CreateDatasetRequestRequestTypeDef
- StartSegmentDetectionRequestRequestTypeDef
- RecognizeCelebritiesResponseTypeDef
- CompareFacesResponseTypeDef
- ProtectiveEquipmentPersonTypeDef
- DetectLabelsResponseTypeDef
- LabelDetectionTypeDef
- CelebrityRecognitionTypeDef
- GetFaceDetectionResponseTypeDef
- PersonDetectionTypeDef
- PersonMatchTypeDef
- IndexFacesResponseTypeDef
- SearchUsersByImageResponseTypeDef
- DetectCustomLabelsResponseTypeDef
- DetectTextResponseTypeDef
- TextDetectionResultTypeDef
- CreateStreamProcessorRequestRequestTypeDef
- DetectTextFiltersTypeDef
- StartTextDetectionFiltersTypeDef
- ListMediaAnalysisJobsResponseTypeDef
- CreateProjectVersionRequestRequestTypeDef
- TestingDataResultTypeDef
- TrainingDataResultTypeDef
- DetectProtectiveEquipmentResponseTypeDef
- GetLabelDetectionResponseTypeDef
- GetCelebrityRecognitionResponseTypeDef
- GetPersonTrackingResponseTypeDef
- GetFaceSearchResponseTypeDef
- GetTextDetectionResponseTypeDef
- DetectTextRequestRequestTypeDef
- StartTextDetectionRequestRequestTypeDef
- ProjectVersionDescriptionTypeDef
- DescribeProjectVersionsResponseTypeDef