mypy-boto3-events

1.42.3 · active · verified Fri Apr 10

mypy-boto3-events provides type annotations for the `boto3` AWS EventBridge service client. It enhances code completion and static type checking for `boto3` interactions, ensuring better code quality and developer experience. This library is part of the `mypy-boto3-builder` project, which frequently updates to match `boto3` and `aioboto3` changes. The current version is 1.42.3.

Warnings

breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and subsequently across all generated `mypy-boto3-*` packages. Python 3.9 or higher is now required.
Fix: Upgrade your Python environment to 3.9 or newer. If stuck on Python 3.8, pin `mypy-boto3-events` to a version older than 1.42.3 (e.g., `mypy-boto3-events<1.42.3`).
breaking The project migrated to PEP 561 compliant packages in `mypy-boto3-builder` version 8.12.0. This change affects how type stubs are discovered and might require adjustments in some build systems or explicit `mypy` configurations.
Fix: Ensure your `mypy` configuration (e.g., `pyproject.toml`) and environment are set up to correctly discover installed PEP 561 packages. For most users, this will work automatically with recent `mypy` versions.
breaking TypeDef names for packed method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`) in `mypy-boto3-builder` version 8.9.0. Conflicting TypeDefs also had their 'Extra' postfix moved to the end.
Fix: Update any explicit imports or references to TypeDefs in your code to reflect the new naming conventions. Consult the specific service's documentation for the exact new names.
gotcha For optimal auto-completion and type inference in some IDEs (e.g., VSCode) and type checkers, explicit type annotations for `boto3.client()`, `boto3.session.client()`, `client.get_waiter()`, and `client.get_paginator()` calls are often recommended, despite the stubs providing implicit discovery.
Fix: Explicitly annotate the return type of `boto3.client('service')` with the corresponding `ServiceClient` type (e.g., `client: EventBridgeClient = boto3.client('events')`).
gotcha When using Pylint, it may report 'undefined variable' errors for type-hinted imports (e.g., `from mypy_boto3_events.client import EventBridgeClient`).
Fix: Wrap your `mypy-boto3` imports in a `if TYPE_CHECKING:` block and define placeholder `object` types for runtime when `TYPE_CHECKING` is false. This makes `mypy-boto3-events` a dev-only dependency and satisfies Pylint.
gotcha Service names within the `mypy-boto3` ecosystem can change (e.g., `sms-voice` became `pinpoint-sms-voice`). While not directly affecting `events` currently, this indicates a potential for future updates to require changes to import paths for specific services.
Fix: Regularly check release notes for `mypy-boto3-builder` and `mypy-boto3-events` for any service name changes or package renames, and update import paths accordingly.

Install

pip install mypy-boto3-events Install service-specific stubs
pip install boto3-stubs[events] Install as part of boto3-stubs (recommended)

Imports

EventBridgeClient
```
from mypy_boto3_events.client import EventBridgeClient
```
Client types are nested under the 'client' submodule for clarity and organization.
ListRulesPaginator
```
from mypy_boto3_events.paginator import ListRulesPaginator
```
Paginator types are available in the 'paginator' submodule.
PutRuleRequestRequestTypeDef
```
from mypy_boto3_events.type_defs import PutRuleRequestRequestTypeDef
```
Service-specific TypeDefs for request/response payloads are in 'type_defs'.

Quickstart

This quickstart demonstrates how to get a type-hinted EventBridge client and use a method with its corresponding TypeDefs. The `TYPE_CHECKING` block ensures that `mypy-boto3-events` is only a dev dependency. Note the explicit type annotation for `boto3.client` is often required for full IDE auto-completion.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_events.client import EventBridgeClient
    from mypy_boto3_events.type_defs import PutRuleResponseTypeDef, PutRuleRequestRequestTypeDef

def get_eventbridge_client() -> 'EventBridgeClient':
    """Initializes and returns a type-hinted EventBridge client."""
    # boto3.client implicitly returns Any, mypy-boto3 provides the type stubs
    client: EventBridgeClient = boto3.client('events')
    return client

def put_example_rule():
    client = get_eventbridge_client()
    
    rule_params: PutRuleRequestRequestTypeDef = {
        "Name": "MyTestRule",
        "EventPattern": "{\"source\":[\"aws.ec2\"]}",
        "State": "ENABLED"
    }
    
    response: PutRuleResponseTypeDef = client.put_rule(**rule_params)
    print(f"Rule ARN: {response.get('RuleArn')}")

if __name__ == "__main__":
    put_example_rule()

view raw JSON →