Skip to content

EventBridge module#

Index > EventBridge

Auto-generated documentation for EventBridge type annotations stubs module mypy-boto3-events.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and EventBridge.

From PyPI with pip#

Install boto3-stubs for EventBridge service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[events]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[events]'


# standalone installation
python -m pip install mypy-boto3-events

How to uninstall#

python -m pip uninstall -y mypy-boto3-events

Usage#

Code samples can be found in Examples.

EventBridgeClient#

Type annotations and code completion for boto3.client("events") as EventBridgeClient boto3 documentation

# EventBridgeClient usage example

from boto3.session import Session

from mypy_boto3_events.client import EventBridgeClient

def get_client() -> EventBridgeClient:
    return Session().client("events")

Paginators#

Type annotations and code completion for paginators from boto3.client("events").get_paginator("...").

# ListRuleNamesByTargetPaginator usage example

from boto3.session import Session

from mypy_boto3_events.paginator import ListRuleNamesByTargetPaginator

def get_list_rule_names_by_target_paginator() -> ListRuleNamesByTargetPaginator:
    return Session().client("events").get_paginator("list_rule_names_by_target"))

Literals#

Type annotations for literals used in methods and schemas.

# ApiDestinationHttpMethodType usage example

from mypy_boto3_events.literals import ApiDestinationHttpMethodType

def get_value() -> ApiDestinationHttpMethodType:
    return "DELETE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ActivateEventSourceRequestRequestTypeDef usage example

from mypy_boto3_events.type_defs import ActivateEventSourceRequestRequestTypeDef

def get_value() -> ActivateEventSourceRequestRequestTypeDef:
    return {
        "Name": ...,
    }