rboto-scheduler

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon EventBridge Scheduler, powered by Rust. This package contains EventBridgeSchedulerClient and 12 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[scheduler]"

You can also install rboto-scheduler directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import EventBridgeSchedulerClient


async def main() -> None:
    client = EventBridgeSchedulerClient(region="us-east-1")
    response = await client.get_schedule(name="nightly-report", group_name="default")
    print(response.schedule_expression, response.state)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import EventBridgeSchedulerClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_scheduler.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_scheduler.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_scheduler.types; native response definitions are in the package's _native.pyi.

Complete signatures

create_schedule

async def create_schedule(
    *,
    name: str,
    schedule_expression: str,
    target: Target,
    flexible_time_window: FlexibleTimeWindow,
    group_name: str | None = None,
    start_date: str | None = None,
    end_date: str | None = None,
    description: str | None = None,
    schedule_expression_timezone: str | None = None,
    state: ScheduleState | None = None,
    kms_key_arn: str | None = None,
    client_token: str | None = None,
    action_after_completion: ActionAfterCompletion | None = None,
) -> CreateScheduleOutput: ...

create_schedule_group

async def create_schedule_group(
    *,
    name: str,
    tags: Sequence[Tag] | None = None,
    client_token: str | None = None,
) -> CreateScheduleGroupOutput: ...

delete_schedule

async def delete_schedule(
    *,
    name: str,
    group_name: str | None = None,
    client_token: str | None = None,
) -> DeleteScheduleOutput: ...

delete_schedule_group

async def delete_schedule_group(
    *,
    name: str,
    client_token: str | None = None,
) -> DeleteScheduleGroupOutput: ...

get_schedule

async def get_schedule(
    *,
    name: str,
    group_name: str | None = None,
) -> GetScheduleOutput: ...

get_schedule_group

async def get_schedule_group(
    *,
    name: str,
) -> GetScheduleGroupOutput: ...

list_schedule_groups

async def list_schedule_groups(
    *,
    name_prefix: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListScheduleGroupsOutput: ...

Also available as client.paginators.list_schedule_groups(...), returning an async iterator of the response type above.

list_schedules

async def list_schedules(
    *,
    group_name: str | None = None,
    name_prefix: str | None = None,
    state: ScheduleState | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListSchedulesOutput: ...

Also available as client.paginators.list_schedules(...), returning an async iterator of the response type above.

list_tags_for_resource

async def list_tags_for_resource(
    *,
    resource_arn: str,
) -> ListTagsForResourceOutput: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: Sequence[Tag],
) -> TagResourceOutput: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: Sequence[str],
) -> UntagResourceOutput: ...

update_schedule

async def update_schedule(
    *,
    name: str,
    schedule_expression: str,
    target: Target,
    flexible_time_window: FlexibleTimeWindow,
    group_name: str | None = None,
    start_date: str | None = None,
    end_date: str | None = None,
    description: str | None = None,
    schedule_expression_timezone: str | None = None,
    state: ScheduleState | None = None,
    kms_key_arn: str | None = None,
    client_token: str | None = None,
    action_after_completion: ActionAfterCompletion | None = None,
) -> UpdateScheduleOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.