Skip to content

EventBridgeScheduler module#

Index > EventBridgeScheduler

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

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 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 schemas.

# AssignPublicIpType usage example

from mypy_boto3_scheduler.literals import AssignPublicIpType

def get_value() -> AssignPublicIpType:
    return "DISABLED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AwsVpcConfigurationTypeDef usage example

from mypy_boto3_scheduler.type_defs import AwsVpcConfigurationTypeDef

def get_value() -> AwsVpcConfigurationTypeDef:
    return {
        "Subnets": ...,
    }