Metadata-Version: 2.4
Name: rboto-bedrock-data-automation
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 Bedrock Data Automation, powered by Rust. Alpha preview.
Keywords: rboto,aws,bedrock-data-automation,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/clients/
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-bedrock-data-automation

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 Bedrock Data Automation**,
powered by Rust. This package contains `BedrockDataAutomationClient` and
**27 operations**.

## Installation

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

```bash
python -m pip install "rboto[bedrock-data-automation]"
```

You can also install `rboto-bedrock-data-automation` 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 BedrockDataAutomationClient


async def main() -> None:
    client = BedrockDataAutomationClient(region="us-east-1")
    response = await client.list_data_automation_projects(max_results=10)
    for project in response.projects:
        print(project.project_arn, project.project_name)


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 BedrockDataAutomationClient`.
- 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_bedrock_data_automation.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_bedrock_data_automation.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_bedrock_data_automation.types`;
native response definitions are in the package's `_native.pyi`.

| Method | Required arguments | Return type |
|---|---|---|
| [`copy_blueprint_stage`](#copy_blueprint_stage) | <code>blueprint_arn: str</code>, <code>source_stage: BlueprintStage</code>, <code>target_stage: BlueprintStage</code> | <code>CopyBlueprintStageOutput</code> |
| [`create_blueprint`](#create_blueprint) | <code>blueprint_name: str</code>, <code>type: Type</code>, <code>schema: str</code> | <code>CreateBlueprintOutput</code> |
| [`create_blueprint_version`](#create_blueprint_version) | <code>blueprint_arn: str</code> | <code>CreateBlueprintVersionOutput</code> |
| [`create_data_automation_library`](#create_data_automation_library) | <code>library_name: str</code> | <code>CreateDataAutomationLibraryOutput</code> |
| [`create_data_automation_project`](#create_data_automation_project) | <code>project_name: str</code>, <code>standard_output_configuration: StandardOutputConfiguration</code> | <code>CreateDataAutomationProjectOutput</code> |
| [`delete_blueprint`](#delete_blueprint) | <code>blueprint_arn: str</code> | <code>DeleteBlueprintOutput</code> |
| [`delete_data_automation_library`](#delete_data_automation_library) | <code>library_arn: str</code> | <code>DeleteDataAutomationLibraryOutput</code> |
| [`delete_data_automation_project`](#delete_data_automation_project) | <code>project_arn: str</code> | <code>DeleteDataAutomationProjectOutput</code> |
| [`get_blueprint`](#get_blueprint) | <code>blueprint_arn: str</code> | <code>GetBlueprintOutput</code> |
| [`get_blueprint_optimization_status`](#get_blueprint_optimization_status) | <code>invocation_arn: str</code> | <code>GetBlueprintOptimizationStatusOutput</code> |
| [`get_data_automation_library`](#get_data_automation_library) | <code>library_arn: str</code> | <code>GetDataAutomationLibraryOutput</code> |
| [`get_data_automation_library_entity`](#get_data_automation_library_entity) | <code>library_arn: str</code>, <code>entity_type: EntityType</code>, <code>entity_id: str</code> | <code>GetDataAutomationLibraryEntityOutput</code> |
| [`get_data_automation_library_ingestion_job`](#get_data_automation_library_ingestion_job) | <code>library_arn: str</code>, <code>job_arn: str</code> | <code>GetDataAutomationLibraryIngestionJobOutput</code> |
| [`get_data_automation_project`](#get_data_automation_project) | <code>project_arn: str</code> | <code>GetDataAutomationProjectOutput</code> |
| [`invoke_blueprint_optimization_async`](#invoke_blueprint_optimization_async) | <code>blueprint: BlueprintOptimizationObject</code>, <code>samples: Sequence[BlueprintOptimizationSample]</code>, <code>output_configuration: BlueprintOptimizationOutputConfiguration</code>, <code>data_automation_profile_arn: str</code> | <code>InvokeBlueprintOptimizationAsyncOutput</code> |
| [`invoke_data_automation_library_ingestion_job`](#invoke_data_automation_library_ingestion_job) | <code>library_arn: str</code>, <code>input_configuration: InputConfiguration</code>, <code>entity_type: EntityType</code>, <code>operation_type: LibraryIngestionJobOperationType</code>, <code>output_configuration: OutputConfiguration</code> | <code>InvokeDataAutomationLibraryIngestionJobOutput</code> |
| [`list_blueprints`](#list_blueprints) | None | <code>ListBlueprintsOutput</code> |
| [`list_data_automation_libraries`](#list_data_automation_libraries) | None | <code>ListDataAutomationLibrariesOutput</code> |
| [`list_data_automation_library_entities`](#list_data_automation_library_entities) | <code>library_arn: str</code>, <code>entity_type: EntityType</code> | <code>ListDataAutomationLibraryEntitiesOutput</code> |
| [`list_data_automation_library_ingestion_jobs`](#list_data_automation_library_ingestion_jobs) | <code>library_arn: str</code> | <code>ListDataAutomationLibraryIngestionJobsOutput</code> |
| [`list_data_automation_projects`](#list_data_automation_projects) | None | <code>ListDataAutomationProjectsOutput</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_blueprint`](#update_blueprint) | <code>blueprint_arn: str</code>, <code>schema: str</code> | <code>UpdateBlueprintOutput</code> |
| [`update_data_automation_library`](#update_data_automation_library) | <code>library_arn: str</code> | <code>UpdateDataAutomationLibraryOutput</code> |
| [`update_data_automation_project`](#update_data_automation_project) | <code>project_arn: str</code>, <code>standard_output_configuration: StandardOutputConfiguration</code> | <code>UpdateDataAutomationProjectOutput</code> |

## Complete signatures

### copy_blueprint_stage

```python
async def copy_blueprint_stage(
    *,
    blueprint_arn: str,
    source_stage: BlueprintStage,
    target_stage: BlueprintStage,
    client_token: str | None = None,
) -> CopyBlueprintStageOutput: ...
```


### create_blueprint

```python
async def create_blueprint(
    *,
    blueprint_name: str,
    type: Type,
    schema: str,
    blueprint_stage: BlueprintStage | None = None,
    client_token: str | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateBlueprintOutput: ...
```


### create_blueprint_version

```python
async def create_blueprint_version(
    *,
    blueprint_arn: str,
    client_token: str | None = None,
) -> CreateBlueprintVersionOutput: ...
```


### create_data_automation_library

```python
async def create_data_automation_library(
    *,
    library_name: str,
    library_description: str | None = None,
    client_token: str | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateDataAutomationLibraryOutput: ...
```


### create_data_automation_project

```python
async def create_data_automation_project(
    *,
    project_name: str,
    standard_output_configuration: StandardOutputConfiguration,
    project_description: str | None = None,
    project_stage: DataAutomationProjectStage | None = None,
    project_type: DataAutomationProjectType | None = None,
    custom_output_configuration: CustomOutputConfiguration | None = None,
    override_configuration: OverrideConfiguration | None = None,
    data_automation_library_configuration: DataAutomationLibraryConfiguration | None = None,
    client_token: str | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateDataAutomationProjectOutput: ...
```


### delete_blueprint

```python
async def delete_blueprint(
    *,
    blueprint_arn: str,
    blueprint_version: str | None = None,
) -> DeleteBlueprintOutput: ...
```


### delete_data_automation_library

```python
async def delete_data_automation_library(
    *,
    library_arn: str,
) -> DeleteDataAutomationLibraryOutput: ...
```


### delete_data_automation_project

```python
async def delete_data_automation_project(
    *,
    project_arn: str,
) -> DeleteDataAutomationProjectOutput: ...
```


### get_blueprint

```python
async def get_blueprint(
    *,
    blueprint_arn: str,
    blueprint_version: str | None = None,
    blueprint_stage: BlueprintStage | None = None,
) -> GetBlueprintOutput: ...
```


### get_blueprint_optimization_status

```python
async def get_blueprint_optimization_status(
    *,
    invocation_arn: str,
) -> GetBlueprintOptimizationStatusOutput: ...
```


### get_data_automation_library

```python
async def get_data_automation_library(
    *,
    library_arn: str,
) -> GetDataAutomationLibraryOutput: ...
```


### get_data_automation_library_entity

```python
async def get_data_automation_library_entity(
    *,
    library_arn: str,
    entity_type: EntityType,
    entity_id: str,
) -> GetDataAutomationLibraryEntityOutput: ...
```


### get_data_automation_library_ingestion_job

```python
async def get_data_automation_library_ingestion_job(
    *,
    library_arn: str,
    job_arn: str,
) -> GetDataAutomationLibraryIngestionJobOutput: ...
```


### get_data_automation_project

```python
async def get_data_automation_project(
    *,
    project_arn: str,
    project_stage: DataAutomationProjectStage | None = None,
) -> GetDataAutomationProjectOutput: ...
```


### invoke_blueprint_optimization_async

```python
async def invoke_blueprint_optimization_async(
    *,
    blueprint: BlueprintOptimizationObject,
    samples: Sequence[BlueprintOptimizationSample],
    output_configuration: BlueprintOptimizationOutputConfiguration,
    data_automation_profile_arn: str,
    encryption_configuration: EncryptionConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
) -> InvokeBlueprintOptimizationAsyncOutput: ...
```


### invoke_data_automation_library_ingestion_job

```python
async def invoke_data_automation_library_ingestion_job(
    *,
    library_arn: str,
    input_configuration: InputConfiguration,
    entity_type: EntityType,
    operation_type: LibraryIngestionJobOperationType,
    output_configuration: OutputConfiguration,
    client_token: str | None = None,
    notification_configuration: NotificationConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
) -> InvokeDataAutomationLibraryIngestionJobOutput: ...
```


### list_blueprints

```python
async def list_blueprints(
    *,
    blueprint_arn: str | None = None,
    resource_owner: ResourceOwner | None = None,
    blueprint_stage_filter: BlueprintStageFilter | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
    project_filter: DataAutomationProjectFilter | None = None,
) -> ListBlueprintsOutput: ...
```

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


### list_data_automation_libraries

```python
async def list_data_automation_libraries(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    project_filter: DataAutomationProjectFilter | None = None,
) -> ListDataAutomationLibrariesOutput: ...
```

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


### list_data_automation_library_entities

```python
async def list_data_automation_library_entities(
    *,
    library_arn: str,
    entity_type: EntityType,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListDataAutomationLibraryEntitiesOutput: ...
```

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


### list_data_automation_library_ingestion_jobs

```python
async def list_data_automation_library_ingestion_jobs(
    *,
    library_arn: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListDataAutomationLibraryIngestionJobsOutput: ...
```

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


### list_data_automation_projects

```python
async def list_data_automation_projects(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
    project_stage_filter: DataAutomationProjectStageFilter | None = None,
    blueprint_filter: BlueprintFilter | None = None,
    resource_owner: ResourceOwner | None = None,
    library_filter: DataAutomationLibraryFilter | None = None,
) -> ListDataAutomationProjectsOutput: ...
```

Also available as `client.paginators.list_data_automation_projects(...)`, 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_blueprint

```python
async def update_blueprint(
    *,
    blueprint_arn: str,
    schema: str,
    blueprint_stage: BlueprintStage | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
) -> UpdateBlueprintOutput: ...
```


### update_data_automation_library

```python
async def update_data_automation_library(
    *,
    library_arn: str,
    library_description: str | None = None,
    client_token: str | None = None,
) -> UpdateDataAutomationLibraryOutput: ...
```


### update_data_automation_project

```python
async def update_data_automation_project(
    *,
    project_arn: str,
    standard_output_configuration: StandardOutputConfiguration,
    project_stage: DataAutomationProjectStage | None = None,
    project_description: str | None = None,
    custom_output_configuration: CustomOutputConfiguration | None = None,
    override_configuration: OverrideConfiguration | None = None,
    data_automation_library_configuration: DataAutomationLibraryConfiguration | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
) -> UpdateDataAutomationProjectOutput: ...
```


## Links

- [Service guide](https://ferrumio.github.io/rboto/clients/)
- [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.

