# mypy-boto3-rekognition<a id="mypy-boto3-rekognition"></a>
[![PyPI - mypy-boto3-rekognition](https://img.shields.io/pypi/v/mypy-boto3-rekognition.svg?color=blue)](https://pypi.org/project/mypy-boto3-rekognition)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-rekognition.svg?color=blue)](https://pypi.org/project/mypy-boto3-rekognition)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-rekognition?color=blue)](https://pypistats.org/packages/mypy-boto3-rekognition)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.Rekognition 1.17.71](https://boto3.amazonaws.com/v1/documentation/api/1.17.71/reference/services/rekognition.html#Rekognition)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-buider 4.12.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-rekognition docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_rekognition/)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-rekognition](#mypy-boto3-rekognition)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install<a id="how-to-install"></a>
Install `boto3-stubs` for `Rekognition` service.
```bash
python -m pip install boto3-stubs[rekognition]
```
## Usage<a id="usage"></a>
### VSCode<a id="vscode"></a>
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[rekognition]` in your environment:
`python -m pip install 'boto3-stubs[rekognition]'`
Both type checking and auto-complete should work for `Rekognition` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm<a id="pycharm"></a>
- Install `boto-stubs[rekognition]` in your environment:
`python -m pip install 'boto3-stubs[rekognition]'`
Both type checking and auto-complete should work for `Rekognition` service. No
explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
### Other IDEs<a id="other-ides"></a>
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy<a id="mypy"></a>
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[rekognition]` in your environment:
`python -m pip install 'boto3-stubs[rekognition]'`
- Run `mypy` as usual
Type checking should work for `Rekognition` service. No explicit type
annotations required, write your `boto3` code as usual.
### pyright<a id="pyright"></a>
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[rekognition]` in your environment:
`python -m pip install 'boto3-stubs[rekognition]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `Rekognition` service. No explicit type
annotations required, write your `boto3` code as usual.
## Explicit type annotations<a id="explicit-type-annotations"></a>
### Client annotations<a id="client-annotations"></a>
`RekognitionClient` provides annotations for `boto3.client("rekognition")`.
```python
import boto3
from mypy_boto3_rekognition import RekognitionClient
client: RekognitionClient = boto3.client("rekognition")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: RekognitionClient = session.client("rekognition")
```
### Paginators annotations<a id="paginators-annotations"></a>
`mypy_boto3_rekognition.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_rekognition import RekognitionClient
from mypy_boto3_rekognition.paginator import (
DescribeProjectVersionsPaginator,
DescribeProjectsPaginator,
ListCollectionsPaginator,
ListFacesPaginator,
ListStreamProcessorsPaginator,
)
client: RekognitionClient = boto3.client("rekognition")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_project_versions_paginator: DescribeProjectVersionsPaginator = client.get_paginator("describe_project_versions")
describe_projects_paginator: DescribeProjectsPaginator = client.get_paginator("describe_projects")
list_collections_paginator: ListCollectionsPaginator = client.get_paginator("list_collections")
list_faces_paginator: ListFacesPaginator = client.get_paginator("list_faces")
list_stream_processors_paginator: ListStreamProcessorsPaginator = client.get_paginator("list_stream_processors")
```
### Waiters annotations<a id="waiters-annotations"></a>
`mypy_boto3_rekognition.waiter` module contains type annotations for all
waiters.
```python
from mypy_boto3_rekognition import RekognitionClient
from mypy_boto3_rekognition.waiter import (
ProjectVersionRunningWaiter,
ProjectVersionTrainingCompletedWaiter,
)
client: RekognitionClient = boto3.client("rekognition")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
project_version_running_waiter: ProjectVersionRunningWaiter = client.get_waiter("project_version_running")
project_version_training_completed_waiter: ProjectVersionTrainingCompletedWaiter = client.get_waiter("project_version_training_completed")
```
### Literals<a id="literals"></a>
`mypy_boto3_rekognition.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_rekognition.literals import (
Attribute,
BodyPart,
CelebrityRecognitionSortBy,
ContentClassifier,
ContentModerationSortBy,
DescribeProjectVersionsPaginatorName,
DescribeProjectsPaginatorName,
EmotionName,
FaceAttributes,
FaceSearchSortBy,
GenderType,
LabelDetectionSortBy,
LandmarkType,
ListCollectionsPaginatorName,
ListFacesPaginatorName,
ListStreamProcessorsPaginatorName,
OrientationCorrection,
PersonTrackingSortBy,
ProjectStatus,
ProjectVersionRunningWaiterName,
ProjectVersionStatus,
ProjectVersionTrainingCompletedWaiterName,
ProtectiveEquipmentType,
QualityFilter,
Reason,
SegmentType,
StreamProcessorStatus,
TechnicalCueType,
TextTypes,
VideoJobStatus,
)
def check_value(value: Attribute) -> bool:
...
```
### Typed dictionaries<a id="typed-dictionaries"></a>
`mypy_boto3_rekognition.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_rekognition.type_defs import (
A