Skip to content

Examples#

Index > DataPipeline > Examples

Auto-generated documentation for DataPipeline type annotations stubs module types-aiobotocore-datapipeline.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[datapipeline] package installed.

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

# DataPipelineClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("datapipeline") as client:  # (1)
    result = await client.create_pipeline()  # (2)
  1. client: DataPipelineClient
  2. result: CreatePipelineOutputTypeDef
# DescribeObjectsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("datapipeline") as client:  # (1)
    paginator = client.get_paginator("describe_objects")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: DataPipelineClient
  2. paginator: DescribeObjectsPaginator
  3. item: DescribeObjectsOutputTypeDef

Explicit type annotations#

With types-aiobotocore-lite[datapipeline] or a standalone types_aiobotocore_datapipeline package, you have to explicitly specify client: DataPipelineClient 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.

# DataPipelineClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_datapipeline.client import DataPipelineClient
from types_aiobotocore_datapipeline.type_defs import CreatePipelineOutputTypeDef
from types_aiobotocore_datapipeline.type_defs import CreatePipelineInputRequestTypeDef


session = get_session()

async with session.create_client("datapipeline") as client:
    client: DataPipelineClient
    kwargs: CreatePipelineInputRequestTypeDef = {...}
    result: CreatePipelineOutputTypeDef = await client.create_pipeline(**kwargs)
# DescribeObjectsPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_datapipeline.client import DataPipelineClient
from types_aiobotocore_datapipeline.paginator import DescribeObjectsPaginator
from types_aiobotocore_datapipeline.type_defs import DescribeObjectsOutputTypeDef


session = get_session()

async with session.create_client("datapipeline") as client:
    client: DataPipelineClient
    paginator: DescribeObjectsPaginator = client.get_paginator("describe_objects")
    async for item in paginator.paginate(...):
        item: DescribeObjectsOutputTypeDef
        print(item)