Skip to content

EventBridgeScheduler module#

Index > EventBridgeScheduler

Auto-generated documentation for EventBridgeScheduler type annotations stubs module mypy-boto3-scheduler.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.19' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add EventBridgeScheduler service.
  4. Use provided commands to install generated packages.

VSCode extension#

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

Click Modify and select boto3 common and EventBridgeScheduler.

From PyPI with pip#

Install boto3-stubs for EventBridgeScheduler service.

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

# 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[scheduler]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

EventBridgeSchedulerClient#

Type annotations and code completion for boto3.client("scheduler") as EventBridgeSchedulerClient boto3 documentation

# EventBridgeSchedulerClient usage example

from boto3.session import Session

from mypy_boto3_scheduler.client import EventBridgeSchedulerClient

def get_client() -> EventBridgeSchedulerClient:
    return Session().client("scheduler")

Paginators#

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

# ListScheduleGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_scheduler.paginator import ListScheduleGroupsPaginator

def get_list_schedule_groups_paginator() -> ListScheduleGroupsPaginator:
    return Session().client("scheduler").get_paginator("list_schedule_groups"))

Literals#

Type annotations for literals used in methods and schema.

# ActionAfterCompletionType usage example

from mypy_boto3_scheduler.literals import ActionAfterCompletionType

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

Type definitions#

Type annotations for type definitions used in methods and schema.