Metadata-Version: 2.4
Name: rboto-pipes
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 Pipes, powered by Rust. Alpha preview.
Keywords: rboto,aws,pipes,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-pipes

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 Pipes**,
powered by Rust. This package contains `EventBridgePipesClient` and
**10 operations**.

## Installation

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

```bash
python -m pip install "rboto[pipes]"
```

You can also install `rboto-pipes` 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 EventBridgePipesClient


async def main() -> None:
    client = EventBridgePipesClient(region="us-east-1")
    response = await client.list_pipes(name_prefix="orders", limit=10)
    for pipe in response.pipes or []:
        print(pipe.name, pipe.current_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 EventBridgePipesClient`.
- 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_pipes.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_pipes.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_pipes.types`;
native response definitions are in the package's `_native.pyi`.

| Method | Required arguments | Return type |
|---|---|---|
| [`create_pipe`](#create_pipe) | <code>name: str</code>, <code>source: str</code>, <code>target: str</code>, <code>role_arn: str</code> | <code>CreatePipeOutput</code> |
| [`delete_pipe`](#delete_pipe) | <code>name: str</code> | <code>DeletePipeOutput</code> |
| [`describe_pipe`](#describe_pipe) | <code>name: str</code> | <code>DescribePipeOutput</code> |
| [`list_pipes`](#list_pipes) | None | <code>ListPipesOutput</code> |
| [`list_tags_for_resource`](#list_tags_for_resource) | <code>resource_arn: str</code> | <code>ListTagsForResourceOutput</code> |
| [`start_pipe`](#start_pipe) | <code>name: str</code> | <code>StartPipeOutput</code> |
| [`stop_pipe`](#stop_pipe) | <code>name: str</code> | <code>StopPipeOutput</code> |
| [`tag_resource`](#tag_resource) | <code>resource_arn: str</code>, <code>tags: dict[str, str]</code> | <code>TagResourceOutput</code> |
| [`untag_resource`](#untag_resource) | <code>resource_arn: str</code>, <code>tag_keys: Sequence[str]</code> | <code>UntagResourceOutput</code> |
| [`update_pipe`](#update_pipe) | <code>name: str</code>, <code>role_arn: str</code> | <code>UpdatePipeOutput</code> |

## Complete signatures

### create_pipe

```python
async def create_pipe(
    *,
    name: str,
    source: str,
    target: str,
    role_arn: str,
    description: str | None = None,
    desired_state: RequestedPipeState | None = None,
    source_parameters: PipeSourceParameters | None = None,
    enrichment: str | None = None,
    enrichment_parameters: PipeEnrichmentParameters | None = None,
    target_parameters: PipeTargetParameters | None = None,
    tags: dict[str, str] | None = None,
    log_configuration: PipeLogConfigurationParameters | None = None,
    kms_key_identifier: str | None = None,
) -> CreatePipeOutput: ...
```


### delete_pipe

```python
async def delete_pipe(
    *,
    name: str,
) -> DeletePipeOutput: ...
```


### describe_pipe

```python
async def describe_pipe(
    *,
    name: str,
) -> DescribePipeOutput: ...
```


### list_pipes

```python
async def list_pipes(
    *,
    name_prefix: str | None = None,
    desired_state: RequestedPipeState | None = None,
    current_state: PipeState | None = None,
    source_prefix: str | None = None,
    target_prefix: str | None = None,
    next_token: str | None = None,
    limit: int | None = None,
) -> ListPipesOutput: ...
```

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


### list_tags_for_resource

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


### start_pipe

```python
async def start_pipe(
    *,
    name: str,
) -> StartPipeOutput: ...
```


### stop_pipe

```python
async def stop_pipe(
    *,
    name: str,
) -> StopPipeOutput: ...
```


### tag_resource

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


### untag_resource

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


### update_pipe

```python
async def update_pipe(
    *,
    name: str,
    role_arn: str,
    description: str | None = None,
    desired_state: RequestedPipeState | None = None,
    source_parameters: UpdatePipeSourceParameters | None = None,
    enrichment: str | None = None,
    enrichment_parameters: PipeEnrichmentParameters | None = None,
    target: str | None = None,
    target_parameters: PipeTargetParameters | None = None,
    log_configuration: PipeLogConfigurationParameters | None = None,
    kms_key_identifier: str | None = None,
) -> UpdatePipeOutput: ...
```


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

