Skip to content

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-aiobotocore[rekognition] package installed.

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

Client method usage example#

# RekognitionClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("rekognition") as client:  # (1)
    result = await client.associate_faces()  # (2)
  1. client: RekognitionClient
  2. result: AssociateFacesResponseTypeDef

Paginator usage example#

# DescribeProjectVersionsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_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#

# ProjectVersionRunningWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_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-aiobotocore-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.

Client method usage example#

# RekognitionClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_rekognition.client import RekognitionClient
from types_aiobotocore_rekognition.type_defs import AssociateFacesResponseTypeDef
from types_aiobotocore_rekognition.type_defs import AssociateFacesRequestTypeDef


session = get_session()

async with session.create_client("rekognition") as client:
    client: RekognitionClient
    kwargs: AssociateFacesRequestTypeDef = {...}
    result: AssociateFacesResponseTypeDef = await client.associate_faces(**kwargs)

Paginator usage example#

# DescribeProjectVersionsPaginator usage example with type annotations

from aiobotocore.session import get_session

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


session = get_session()

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

Waiter usage example#

# ProjectVersionRunningWaiter usage example with type annotations

from aiobotocore.session import get_session

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


session = get_session()

async with session.create_client("rekognition") as client:
    client: RekognitionClient
    waiter: ProjectVersionRunningWaiter = client.get_waiter("project_version_running")
    await waiter.wait(...)