Examples

Index > EventBridgePipes > Examples

Auto-generated documentation for EventBridgePipes type annotations stubs module types-aiobotocore-pipes.

Client

Implicit type annotations

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

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

# EventBridgePipesClient usage example

from aioboto3.session import Session


session = Session()

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

1. client: EventBridgePipesClient
2. result: CreatePipeResponseTypeDef

# ListPipesPaginator usage example

from aioboto3.session import Session


session = Session()

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

1. client: EventBridgePipesClient
2. paginator: ListPipesPaginator
3. item: ListPipesResponseTypeDef

Explicit type annotations

With types-aioboto3-lite[pipes] or a standalone types_aiobotocore_pipes package, you have to explicitly specify client: EventBridgePipesClient 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.

# EventBridgePipesClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_pipes.client import EventBridgePipesClient
from types_aiobotocore_pipes.type_defs import CreatePipeResponseTypeDef
from types_aiobotocore_pipes.type_defs import CreatePipeRequestRequestTypeDef


session = Session()

client: EventBridgePipesClient
async with session.client("pipes") as client:  # (1)
    kwargs: CreatePipeRequestRequestTypeDef = {...}  # (2)
    result: CreatePipeResponseTypeDef = await client.create_pipe(**kwargs)  # (3)

1. client: EventBridgePipesClient
2. kwargs: CreatePipeRequestRequestTypeDef
3. result: CreatePipeResponseTypeDef

# ListPipesPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_pipes.client import EventBridgePipesClient
from types_aiobotocore_pipes.paginator import ListPipesPaginator
from types_aiobotocore_pipes.type_defs import ListPipesResponseTypeDef


session = Session()

client: EventBridgePipesClient
async with session.client("pipes") as client:  # (1)
    paginator: ListPipesPaginator = client.get_paginator("list_pipes")  # (2)
    async for item in paginator.paginate(...):
        item: ListPipesResponseTypeDef
        print(item)  # (3)

1. client: EventBridgePipesClient
2. paginator: ListPipesPaginator
3. item: ListPipesResponseTypeDef