Skip to content

Examples#

Index > EventBridge > Examples

Auto-generated documentation for EventBridge type annotations stubs module types-aiobotocore-events.

Client#

Implicit type annotations#

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

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

# EventBridgeClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("events") as client:  # (1)
    result = await client.activate_event_source()  # (2)
  1. client: EventBridgeClient
  2. result: EmptyResponseMetadataTypeDef
# ListRuleNamesByTargetPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("events") as client:  # (1)
    paginator = client.get_paginator("list_rule_names_by_target")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: EventBridgeClient
  2. paginator: ListRuleNamesByTargetPaginator
  3. item: ListRuleNamesByTargetResponseTypeDef

Explicit type annotations#

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

# EventBridgeClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_events.client import EventBridgeClient
from types_aiobotocore_events.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_events.type_defs import ActivateEventSourceRequestRequestTypeDef


session = get_session()

async with session.create_client("events") as client:
    client: EventBridgeClient
    kwargs: ActivateEventSourceRequestRequestTypeDef = {...}
    result: EmptyResponseMetadataTypeDef = await client.activate_event_source(**kwargs)
# ListRuleNamesByTargetPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_events.client import EventBridgeClient
from types_aiobotocore_events.paginator import ListRuleNamesByTargetPaginator
from types_aiobotocore_events.type_defs import ListRuleNamesByTargetResponseTypeDef


session = get_session()

async with session.create_client("events") as client:
    client: EventBridgeClient
    paginator: ListRuleNamesByTargetPaginator = client.get_paginator("list_rule_names_by_target")
    async for item in paginator.paginate(...):
        item: ListRuleNamesByTargetResponseTypeDef
        print(item)