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-aioboto3[events]
package installed.
Write your EventBridge
code as usual,
type checking and code completion should work out of the box.
# EventBridgeClient usage example
from aioboto3.session import Session
session = Session()
async with session.client("events") as client: # (1)
result = await client.activate_event_source() # (2)
- client: EventBridgeClient
- result: EmptyResponseMetadataTypeDef
# ListRuleNamesByTargetPaginator usage example
from aioboto3.session import Session
session = Session()
async with session.client("events") as client: # (1)
paginator = client.get_paginator("list_rule_names_by_target") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: EventBridgeClient
- paginator: ListRuleNamesByTargetPaginator
- item: ListRuleNamesByTargetResponseTypeDef
Explicit type annotations#
With types-aioboto3-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 aioboto3.session import 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 = Session()
client: EventBridgeClient
async with session.client("events") as client: # (1)
kwargs: ActivateEventSourceRequestRequestTypeDef = {...} # (2)
result: EmptyResponseMetadataTypeDef = await client.activate_event_source(**kwargs) # (3)
- client: EventBridgeClient
- kwargs: ActivateEventSourceRequestRequestTypeDef
- result: EmptyResponseMetadataTypeDef
# ListRuleNamesByTargetPaginator usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_events.client import EventBridgeClient
from types_aiobotocore_events.paginator import ListRuleNamesByTargetPaginator
from types_aiobotocore_events.type_defs import ListRuleNamesByTargetResponseTypeDef
session = Session()
client: EventBridgeClient
async with session.client("events") as client: # (1)
paginator: ListRuleNamesByTargetPaginator = client.get_paginator("list_rule_names_by_target") # (2)
async for item in paginator.paginate(...):
item: ListRuleNamesByTargetResponseTypeDef
print(item) # (3)
- client: EventBridgeClient
- paginator: ListRuleNamesByTargetPaginator
- item: ListRuleNamesByTargetResponseTypeDef