Rekognition module#
Index > Rekognition
Auto-generated documentation for Rekognition type annotations stubs module types-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.36.26' mypy-boto3-builder
- Select
boto3
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 types-boto3
for Rekognition
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[rekognition]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[rekognition]'
# standalone installation
python -m pip install types-boto3-rekognition
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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 types_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 types_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
- AssociateFacesRequestTypeDef
- AssociatedFaceTypeDef
- ResponseMetadataTypeDef
- UnsuccessfulFaceAssociationTypeDef
- AudioMetadataTypeDef
- BoundingBoxTypeDef
- S3ObjectTypeDef
- BeardTypeDef
- BlackFrameTypeDef
- BlobTypeDef
- KnownGenderTypeDef
- EmotionTypeDef
- ImageQualityTypeDef
- LandmarkTypeDef
- PoseTypeDef
- SmileTypeDef
- ConnectedHomeSettingsForUpdateTypeDef
- ConnectedHomeSettingsOutputTypeDef
- ConnectedHomeSettingsTypeDef
- ContentTypeTypeDef
- ModerationLabelTypeDef
- OutputConfigTypeDef
- CoversBodyPartTypeDef
- CreateCollectionRequestTypeDef
- LivenessOutputConfigTypeDef
- CreateProjectRequestTypeDef
- StreamProcessorDataSharingPreferenceTypeDef
- StreamProcessorNotificationChannelTypeDef
- CreateUserRequestTypeDef
- CustomizationFeatureContentModerationConfigTypeDef
- DatasetStatsTypeDef
- DatasetLabelStatsTypeDef
- DatasetMetadataTypeDef
- DeleteCollectionRequestTypeDef
- DeleteDatasetRequestTypeDef
- DeleteFacesRequestTypeDef
- UnsuccessfulFaceDeletionTypeDef
- DeleteProjectPolicyRequestTypeDef
- DeleteProjectRequestTypeDef
- DeleteProjectVersionRequestTypeDef
- DeleteStreamProcessorRequestTypeDef
- DeleteUserRequestTypeDef
- DescribeCollectionRequestTypeDef
- DescribeDatasetRequestTypeDef
- PaginatorConfigTypeDef
- DescribeProjectVersionsRequestTypeDef
- WaiterConfigTypeDef
- DescribeProjectsRequestTypeDef
- DescribeStreamProcessorRequestTypeDef
- DetectLabelsImageQualityTypeDef
- DominantColorTypeDef
- DetectLabelsImagePropertiesSettingsTypeDef
- GeneralLabelsSettingsTypeDef
- HumanLoopActivationOutputTypeDef
- ProtectiveEquipmentSummarizationAttributesTypeDef
- ProtectiveEquipmentSummaryTypeDef
- DetectionFilterTypeDef
- DisassociateFacesRequestTypeDef
- DisassociatedFaceTypeDef
- UnsuccessfulFaceDisassociationTypeDef
- DistributeDatasetTypeDef
- EyeDirectionTypeDef
- EyeOpenTypeDef
- EyeglassesTypeDef
- FaceOccludedTypeDef
- GenderTypeDef
- MouthOpenTypeDef
- MustacheTypeDef
- SunglassesTypeDef
- FaceSearchSettingsTypeDef
- PointTypeDef
- GetCelebrityInfoRequestTypeDef
- GetCelebrityRecognitionRequestTypeDef
- VideoMetadataTypeDef
- GetContentModerationRequestMetadataTypeDef
- GetContentModerationRequestTypeDef
- GetFaceDetectionRequestTypeDef
- GetFaceLivenessSessionResultsRequestTypeDef
- GetFaceSearchRequestTypeDef
- GetLabelDetectionRequestMetadataTypeDef
- GetLabelDetectionRequestTypeDef
- GetMediaAnalysisJobRequestTypeDef
- MediaAnalysisJobFailureDetailsTypeDef
- MediaAnalysisOutputConfigTypeDef
- GetPersonTrackingRequestTypeDef
- GetSegmentDetectionRequestTypeDef
- SegmentTypeInfoTypeDef
- GetTextDetectionRequestTypeDef
- HumanLoopDataAttributesTypeDef
- KinesisDataStreamTypeDef
- KinesisVideoStreamStartSelectorTypeDef
- KinesisVideoStreamTypeDef
- LabelAliasTypeDef
- LabelCategoryTypeDef
- ParentTypeDef
- ListCollectionsRequestTypeDef
- ListDatasetEntriesRequestTypeDef
- ListDatasetLabelsRequestTypeDef
- ListFacesRequestTypeDef
- ListMediaAnalysisJobsRequestTypeDef
- ListProjectPoliciesRequestTypeDef
- ProjectPolicyTypeDef
- ListStreamProcessorsRequestTypeDef
- StreamProcessorTypeDef
- ListTagsForResourceRequestTypeDef
- ListUsersRequestTypeDef
- UserTypeDef
- MatchedUserTypeDef
- MediaAnalysisDetectModerationLabelsConfigTypeDef
- MediaAnalysisModelVersionsTypeDef
- NotificationChannelTypeDef
- PutProjectPolicyRequestTypeDef
- S3DestinationTypeDef
- SearchFacesRequestTypeDef
- SearchUsersRequestTypeDef
- SearchedFaceTypeDef
- SearchedUserTypeDef
- ShotSegmentTypeDef
- TechnicalCueSegmentTypeDef
- StartProjectVersionRequestTypeDef
- StartShotDetectionFilterTypeDef
- StreamProcessingStopSelectorTypeDef
- StopProjectVersionRequestTypeDef
- StopStreamProcessorRequestTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- 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
- ContentModerationDetectionTypeDef
- CopyProjectVersionRequestTypeDef
- EquipmentDetectionTypeDef
- CreateFaceLivenessSessionRequestSettingsTypeDef
- CustomizationFeatureConfigTypeDef
- DatasetDescriptionTypeDef
- DatasetLabelDescriptionTypeDef
- ProjectDescriptionTypeDef
- DeleteFacesResponseTypeDef
- DescribeProjectVersionsRequestPaginateTypeDef
- DescribeProjectsRequestPaginateTypeDef
- ListCollectionsRequestPaginateTypeDef
- ListDatasetEntriesRequestPaginateTypeDef
- ListDatasetLabelsRequestPaginateTypeDef
- ListFacesRequestPaginateTypeDef
- ListProjectPoliciesRequestPaginateTypeDef
- ListStreamProcessorsRequestPaginateTypeDef
- ListUsersRequestPaginateTypeDef
- DescribeProjectVersionsRequestWaitExtraTypeDef
- DescribeProjectVersionsRequestWaitTypeDef
- DetectLabelsImageBackgroundTypeDef
- DetectLabelsImageForegroundTypeDef
- InstanceTypeDef
- DetectLabelsSettingsTypeDef
- LabelDetectionSettingsTypeDef
- DetectModerationLabelsResponseTypeDef
- DisassociateFacesResponseTypeDef
- DistributeDatasetEntriesRequestTypeDef
- FaceDetailTypeDef
- StreamProcessorSettingsOutputTypeDef
- StreamProcessorSettingsTypeDef
- GeometryTypeDef
- RegionOfInterestOutputTypeDef
- RegionOfInterestTypeDef
- HumanLoopConfigTypeDef
- StreamProcessingStartSelectorTypeDef
- StreamProcessorInputTypeDef
- ListProjectPoliciesResponseTypeDef
- ListStreamProcessorsResponseTypeDef
- ListUsersResponseTypeDef
- UserMatchTypeDef
- MediaAnalysisOperationsConfigTypeDef
- MediaAnalysisResultsTypeDef
- StreamProcessorOutputTypeDef
- SegmentDetectionTypeDef
- FaceMatchTypeDef
- ListFacesResponseTypeDef
- GetFaceLivenessSessionResultsResponseTypeDef
- AssetTypeDef
- DatasetSourceTypeDef
- EvaluationResultTypeDef
- StartCelebrityRecognitionRequestTypeDef
- StartContentModerationRequestTypeDef
- StartFaceDetectionRequestTypeDef
- StartFaceSearchRequestTypeDef
- StartPersonTrackingRequestTypeDef
- StartSegmentDetectionFiltersTypeDef
- UpdateDatasetEntriesRequestTypeDef
- CompareFacesRequestTypeDef
- DetectCustomLabelsRequestTypeDef
- DetectFacesRequestTypeDef
- DetectProtectiveEquipmentRequestTypeDef
- IndexFacesRequestTypeDef
- RecognizeCelebritiesRequestTypeDef
- SearchFacesByImageRequestTypeDef
- SearchUsersByImageRequestTypeDef
- CelebrityTypeDef
- CompareFacesMatchTypeDef
- GetContentModerationResponseTypeDef
- ProtectiveEquipmentBodyPartTypeDef
- CreateFaceLivenessSessionRequestTypeDef
- DescribeDatasetResponseTypeDef
- ListDatasetLabelsResponseTypeDef
- DescribeProjectsResponseTypeDef
- DetectLabelsImagePropertiesTypeDef
- LabelTypeDef
- DetectLabelsRequestTypeDef
- StartLabelDetectionRequestTypeDef
- CelebrityDetailTypeDef
- DetectFacesResponseTypeDef
- FaceDetectionTypeDef
- FaceRecordTypeDef
- PersonDetailTypeDef
- SearchedFaceDetailsTypeDef
- UnindexedFaceTypeDef
- UnsearchedFaceTypeDef
- StreamProcessorSettingsUnionTypeDef
- CustomLabelTypeDef
- TextDetectionTypeDef
- RegionOfInterestUnionTypeDef
- DetectModerationLabelsRequestTypeDef
- StartStreamProcessorRequestTypeDef
- SearchUsersResponseTypeDef
- StartMediaAnalysisJobRequestTypeDef
- GetMediaAnalysisJobResponseTypeDef
- MediaAnalysisJobDescriptionTypeDef
- DescribeStreamProcessorResponseTypeDef
- GetSegmentDetectionResponseTypeDef
- SearchFacesByImageResponseTypeDef
- SearchFacesResponseTypeDef
- TestingDataOutputTypeDef
- TestingDataTypeDef
- TrainingDataOutputTypeDef
- TrainingDataTypeDef
- ValidationDataTypeDef
- CreateDatasetRequestTypeDef
- StartSegmentDetectionRequestTypeDef
- RecognizeCelebritiesResponseTypeDef
- CompareFacesResponseTypeDef
- ProtectiveEquipmentPersonTypeDef
- DetectLabelsResponseTypeDef
- LabelDetectionTypeDef
- CelebrityRecognitionTypeDef
- GetFaceDetectionResponseTypeDef
- PersonDetectionTypeDef
- PersonMatchTypeDef
- IndexFacesResponseTypeDef
- SearchUsersByImageResponseTypeDef
- DetectCustomLabelsResponseTypeDef
- DetectTextResponseTypeDef
- TextDetectionResultTypeDef
- CreateStreamProcessorRequestTypeDef
- DetectTextFiltersTypeDef
- StartTextDetectionFiltersTypeDef
- UpdateStreamProcessorRequestTypeDef
- ListMediaAnalysisJobsResponseTypeDef
- TestingDataUnionTypeDef
- TrainingDataUnionTypeDef
- TestingDataResultTypeDef
- TrainingDataResultTypeDef
- DetectProtectiveEquipmentResponseTypeDef
- GetLabelDetectionResponseTypeDef
- GetCelebrityRecognitionResponseTypeDef
- GetPersonTrackingResponseTypeDef
- GetFaceSearchResponseTypeDef
- GetTextDetectionResponseTypeDef
- DetectTextRequestTypeDef
- StartTextDetectionRequestTypeDef
- CreateProjectVersionRequestTypeDef
- ProjectVersionDescriptionTypeDef
- DescribeProjectVersionsResponseTypeDef