Metadata-Version: 2.4
Name: rboto-scheduler
Version: 0.1.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: AsyncIO
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: rboto==0.1.0
License-File: LICENSE
Summary: rboto: async-only, typed Python client for Amazon EventBridge Scheduler, powered by Rust. Alpha preview.
Keywords: rboto,aws,scheduler,asyncio,typing,rust
Home-Page: https://github.com/ferrumio/rboto
Author-email: Leandro Cavalcante Damascena <leandro.damascena@gmail.com>
License-Expression: Apache-2.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/ferrumio/rboto/releases
Project-URL: Documentation, https://ferrumio.github.io/rboto/guides/events/
Project-URL: Homepage, https://ferrumio.github.io/rboto/
Project-URL: Issues, https://github.com/ferrumio/rboto/issues
Project-URL: Repository, https://github.com/ferrumio/rboto

<!-- Generated by rboto-codegen. Edit the descriptor, template, or example source. -->
# rboto-scheduler

rboto is an independent project maintained by [Ferrumio](https://github.com/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.

```bash
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](https://ferrumio.github.io/rboto/getting-started/).

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

```python
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](https://ferrumio.github.io/rboto/guides/configuration/),
[errors](https://ferrumio.github.io/rboto/guides/errors/), and
[streaming](https://ferrumio.github.io/rboto/guides/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`.

| Method | Required arguments | Return type |
|---|---|---|
| [`create_schedule`](#create_schedule) | <code>name: str</code>, <code>schedule_expression: str</code>, <code>target: Target</code>, <code>flexible_time_window: FlexibleTimeWindow</code> | <code>CreateScheduleOutput</code> |
| [`create_schedule_group`](#create_schedule_group) | <code>name: str</code> | <code>CreateScheduleGroupOutput</code> |
| [`delete_schedule`](#delete_schedule) | <code>name: str</code> | <code>DeleteScheduleOutput</code> |
| [`delete_schedule_group`](#delete_schedule_group) | <code>name: str</code> | <code>DeleteScheduleGroupOutput</code> |
| [`get_schedule`](#get_schedule) | <code>name: str</code> | <code>GetScheduleOutput</code> |
| [`get_schedule_group`](#get_schedule_group) | <code>name: str</code> | <code>GetScheduleGroupOutput</code> |
| [`list_schedule_groups`](#list_schedule_groups) | None | <code>ListScheduleGroupsOutput</code> |
| [`list_schedules`](#list_schedules) | None | <code>ListSchedulesOutput</code> |
| [`list_tags_for_resource`](#list_tags_for_resource) | <code>resource_arn: str</code> | <code>ListTagsForResourceOutput</code> |
| [`tag_resource`](#tag_resource) | <code>resource_arn: str</code>, <code>tags: Sequence[Tag]</code> | <code>TagResourceOutput</code> |
| [`untag_resource`](#untag_resource) | <code>resource_arn: str</code>, <code>tag_keys: Sequence[str]</code> | <code>UntagResourceOutput</code> |
| [`update_schedule`](#update_schedule) | <code>name: str</code>, <code>schedule_expression: str</code>, <code>target: Target</code>, <code>flexible_time_window: FlexibleTimeWindow</code> | <code>UpdateScheduleOutput</code> |

## Complete signatures

### create_schedule

```python
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

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


### delete_schedule

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


### delete_schedule_group

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


### get_schedule

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


### get_schedule_group

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


### list_schedule_groups

```python
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

```python
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

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


### tag_resource

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


### untag_resource

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


### update_schedule

```python
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](https://ferrumio.github.io/rboto/guides/events/)
- [Repository](https://github.com/ferrumio/rboto)
- [Issues](https://github.com/ferrumio/rboto/issues)
- [Releases](https://github.com/ferrumio/rboto/releases)

Licensed under Apache-2.0.

