Examples

Index > Rekognition > Examples

Auto-generated documentation for Rekognition type annotations stubs module types-aiobotocore-rekognition.

Client

Implicit type annotations

Can be used with types-aioboto3[rekognition] package installed.

Write your Rekognition code as usual, type checking and code completion should work out of the box.

ClientPaginatorsWaiters

Client usage example

from aioboto3.session import Session


session = Session()

async with session.client("rekognition") as client:  # (1)
    result = await client.compare_faces()  # (2)

1. client: RekognitionClient
2. result: CompareFacesResponseTypeDef

Paginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("rekognition") as client:  # (1)
    paginator = client.get_paginator("describe_project_versions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: RekognitionClient
2. paginator: DescribeProjectVersionsPaginator
3. item: DescribeProjectVersionsResponseTypeDef

Waiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("rekognition") as client:  # (1)
    waiter = client.get_waiter("project_version_running")  # (2)
    await waiter.wait()

1. client: RekognitionClient
2. waiter: ProjectVersionRunningWaiter

Explicit type annotations

With types-aioboto3-lite[rekognition] or a standalone types_aiobotocore_rekognition package, you have to explicitly specify client: RekognitionClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

ClientPaginatorsWaiters

Client usage example

from aioboto3.session import Session

from types_aiobotocore_rekognition.client import RekognitionClient
from types_aiobotocore_rekognition.type_defs import CompareFacesResponseTypeDef
from types_aiobotocore_rekognition.type_defs import CompareFacesRequestRequestTypeDef


session = Session()

client: RekognitionClient
async with session.client("rekognition") as client:  # (1)
    kwargs: CompareFacesRequestRequestTypeDef = {...}  # (2)
    result: CompareFacesResponseTypeDef = await client.compare_faces(**kwargs)  # (3)

1. client: RekognitionClient
2. kwargs: CompareFacesRequestRequestTypeDef
3. result: CompareFacesResponseTypeDef

Paginator usage example

from aioboto3.session import Session

from types_aiobotocore_rekognition.client import RekognitionClient
from types_aiobotocore_rekognition.paginator import DescribeProjectVersionsPaginator
from types_aiobotocore_rekognition.type_defs import DescribeProjectVersionsResponseTypeDef


session = Session()

client: RekognitionClient
async with session.client("rekognition") as client:  # (1)
    paginator: DescribeProjectVersionsPaginator = client.get_paginator("describe_project_versions")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeProjectVersionsResponseTypeDef
        print(item)  # (3)

1. client: RekognitionClient
2. paginator: DescribeProjectVersionsPaginator
3. item: DescribeProjectVersionsResponseTypeDef

Waiter usage example

from aioboto3.session import Session

from types_aiobotocore_rekognition.client import RekognitionClient
from types_aiobotocore_rekognition.waiter import ProjectVersionRunningWaiter


session = Session()

async with session.client("rekognition") as client:  # (1)
    waiter = client.get_waiter("project_version_running")  # (2)
    await waiter.wait()

1. client: RekognitionClient
2. waiter: ProjectVersionRunningWaiter