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

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 Agents**,
powered by Rust. This package contains `BedrockAgentClient` and
**86 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-agent]"
```

You can also install `rboto-bedrock-agent` 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 BedrockAgentClient


async def main() -> None:
    client = BedrockAgentClient(region="us-east-1")
    response = await client.list_agents(max_results=10)
    for agent in response.agent_summaries:
        print(agent.agent_id, agent.agent_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 BedrockAgentClient`.
- 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_agent.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_agent.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_agent.types`;
native response definitions are in the package's `_native.pyi`.

| Method | Required arguments | Return type |
|---|---|---|
| [`associate_agent_collaborator`](#associate_agent_collaborator) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>agent_descriptor: AgentDescriptor</code>, <code>collaborator_name: str</code>, <code>collaboration_instruction: str</code> | <code>AssociateAgentCollaboratorOutput</code> |
| [`associate_agent_knowledge_base`](#associate_agent_knowledge_base) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>knowledge_base_id: str</code>, <code>description: str</code> | <code>AssociateAgentKnowledgeBaseOutput</code> |
| [`create_agent`](#create_agent) | <code>agent_name: str</code> | <code>CreateAgentOutput</code> |
| [`create_agent_action_group`](#create_agent_action_group) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>action_group_name: str</code> | <code>CreateAgentActionGroupOutput</code> |
| [`create_agent_alias`](#create_agent_alias) | <code>agent_id: str</code>, <code>agent_alias_name: str</code> | <code>CreateAgentAliasOutput</code> |
| [`create_data_source`](#create_data_source) | <code>knowledge_base_id: str</code>, <code>name: str</code>, <code>data_source_configuration: DataSourceConfiguration</code> | <code>CreateDataSourceOutput</code> |
| [`create_flow`](#create_flow) | <code>name: str</code>, <code>execution_role_arn: str</code> | <code>CreateFlowOutput</code> |
| [`create_flow_alias`](#create_flow_alias) | <code>name: str</code>, <code>routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem]</code>, <code>flow_identifier: str</code> | <code>CreateFlowAliasOutput</code> |
| [`create_flow_version`](#create_flow_version) | <code>flow_identifier: str</code> | <code>CreateFlowVersionOutput</code> |
| [`create_knowledge_base`](#create_knowledge_base) | <code>name: str</code>, <code>role_arn: str</code>, <code>knowledge_base_configuration: KnowledgeBaseConfiguration</code> | <code>CreateKnowledgeBaseOutput</code> |
| [`create_prompt`](#create_prompt) | <code>name: str</code> | <code>CreatePromptOutput</code> |
| [`create_prompt_version`](#create_prompt_version) | <code>prompt_identifier: str</code> | <code>CreatePromptVersionOutput</code> |
| [`create_retrieval_instruction`](#create_retrieval_instruction) | <code>name: str</code>, <code>instruction: RetrievalInstructionContent</code> | <code>CreateRetrievalInstructionOutput</code> |
| [`create_retrieval_instruction_version`](#create_retrieval_instruction_version) | <code>retrieval_instruction_id: str</code> | <code>CreateRetrievalInstructionVersionOutput</code> |
| [`create_vpc_configuration`](#create_vpc_configuration) | <code>knowledge_base_id: str</code>, <code>vpc_id: str</code>, <code>subnet_ids: Sequence[str]</code>, <code>resource_target: str</code>, <code>port: int</code>, <code>protocol: VpcProtocol</code>, <code>resolution_mode: VpcResolutionMode</code> | <code>CreateVpcConfigurationOutput</code> |
| [`delete_agent`](#delete_agent) | <code>agent_id: str</code> | <code>DeleteAgentOutput</code> |
| [`delete_agent_action_group`](#delete_agent_action_group) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>action_group_id: str</code> | <code>DeleteAgentActionGroupOutput</code> |
| [`delete_agent_alias`](#delete_agent_alias) | <code>agent_id: str</code>, <code>agent_alias_id: str</code> | <code>DeleteAgentAliasOutput</code> |
| [`delete_agent_version`](#delete_agent_version) | <code>agent_id: str</code>, <code>agent_version: str</code> | <code>DeleteAgentVersionOutput</code> |
| [`delete_data_source`](#delete_data_source) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code> | <code>DeleteDataSourceOutput</code> |
| [`delete_flow`](#delete_flow) | <code>flow_identifier: str</code> | <code>DeleteFlowOutput</code> |
| [`delete_flow_alias`](#delete_flow_alias) | <code>flow_identifier: str</code>, <code>alias_identifier: str</code> | <code>DeleteFlowAliasOutput</code> |
| [`delete_flow_version`](#delete_flow_version) | <code>flow_identifier: str</code>, <code>flow_version: str</code> | <code>DeleteFlowVersionOutput</code> |
| [`delete_knowledge_base`](#delete_knowledge_base) | <code>knowledge_base_id: str</code> | <code>DeleteKnowledgeBaseOutput</code> |
| [`delete_knowledge_base_documents`](#delete_knowledge_base_documents) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>document_identifiers: Sequence[DocumentIdentifier]</code> | <code>DeleteKnowledgeBaseDocumentsOutput</code> |
| [`delete_prompt`](#delete_prompt) | <code>prompt_identifier: str</code> | <code>DeletePromptOutput</code> |
| [`delete_resource_policy`](#delete_resource_policy) | <code>resource_arn: str</code> | <code>DeleteResourcePolicyOutput</code> |
| [`delete_retrieval_instruction`](#delete_retrieval_instruction) | <code>retrieval_instruction_id: str</code> | <code>DeleteRetrievalInstructionOutput</code> |
| [`delete_vpc_configuration`](#delete_vpc_configuration) | <code>knowledge_base_id: str</code>, <code>vpc_configuration_id: str</code> | <code>DeleteVpcConfigurationOutput</code> |
| [`disassociate_agent_collaborator`](#disassociate_agent_collaborator) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>collaborator_id: str</code> | <code>DisassociateAgentCollaboratorOutput</code> |
| [`disassociate_agent_knowledge_base`](#disassociate_agent_knowledge_base) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>knowledge_base_id: str</code> | <code>DisassociateAgentKnowledgeBaseOutput</code> |
| [`get_agent`](#get_agent) | <code>agent_id: str</code> | <code>GetAgentOutput</code> |
| [`get_agent_action_group`](#get_agent_action_group) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>action_group_id: str</code> | <code>GetAgentActionGroupOutput</code> |
| [`get_agent_alias`](#get_agent_alias) | <code>agent_id: str</code>, <code>agent_alias_id: str</code> | <code>GetAgentAliasOutput</code> |
| [`get_agent_collaborator`](#get_agent_collaborator) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>collaborator_id: str</code> | <code>GetAgentCollaboratorOutput</code> |
| [`get_agent_knowledge_base`](#get_agent_knowledge_base) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>knowledge_base_id: str</code> | <code>GetAgentKnowledgeBaseOutput</code> |
| [`get_agent_version`](#get_agent_version) | <code>agent_id: str</code>, <code>agent_version: str</code> | <code>GetAgentVersionOutput</code> |
| [`get_data_source`](#get_data_source) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code> | <code>GetDataSourceOutput</code> |
| [`get_flow`](#get_flow) | <code>flow_identifier: str</code> | <code>GetFlowOutput</code> |
| [`get_flow_alias`](#get_flow_alias) | <code>flow_identifier: str</code>, <code>alias_identifier: str</code> | <code>GetFlowAliasOutput</code> |
| [`get_flow_version`](#get_flow_version) | <code>flow_identifier: str</code>, <code>flow_version: str</code> | <code>GetFlowVersionOutput</code> |
| [`get_ingestion_job`](#get_ingestion_job) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>ingestion_job_id: str</code> | <code>GetIngestionJobOutput</code> |
| [`get_knowledge_base`](#get_knowledge_base) | <code>knowledge_base_id: str</code> | <code>GetKnowledgeBaseOutput</code> |
| [`get_knowledge_base_documents`](#get_knowledge_base_documents) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>document_identifiers: Sequence[DocumentIdentifier]</code> | <code>GetKnowledgeBaseDocumentsOutput</code> |
| [`get_prompt`](#get_prompt) | <code>prompt_identifier: str</code> | <code>GetPromptOutput</code> |
| [`get_resource_policy`](#get_resource_policy) | <code>resource_arn: str</code> | <code>GetResourcePolicyOutput</code> |
| [`get_retrieval_instruction`](#get_retrieval_instruction) | <code>retrieval_instruction_id: str</code> | <code>GetRetrievalInstructionOutput</code> |
| [`get_vpc_configuration`](#get_vpc_configuration) | <code>knowledge_base_id: str</code>, <code>vpc_configuration_id: str</code> | <code>GetVpcConfigurationOutput</code> |
| [`ingest_knowledge_base_documents`](#ingest_knowledge_base_documents) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>documents: Sequence[KnowledgeBaseDocument]</code> | <code>IngestKnowledgeBaseDocumentsOutput</code> |
| [`list_agent_action_groups`](#list_agent_action_groups) | <code>agent_id: str</code>, <code>agent_version: str</code> | <code>ListAgentActionGroupsOutput</code> |
| [`list_agent_aliases`](#list_agent_aliases) | <code>agent_id: str</code> | <code>ListAgentAliasesOutput</code> |
| [`list_agent_collaborators`](#list_agent_collaborators) | <code>agent_id: str</code>, <code>agent_version: str</code> | <code>ListAgentCollaboratorsOutput</code> |
| [`list_agent_knowledge_bases`](#list_agent_knowledge_bases) | <code>agent_id: str</code>, <code>agent_version: str</code> | <code>ListAgentKnowledgeBasesOutput</code> |
| [`list_agent_versions`](#list_agent_versions) | <code>agent_id: str</code> | <code>ListAgentVersionsOutput</code> |
| [`list_agents`](#list_agents) | None | <code>ListAgentsOutput</code> |
| [`list_data_sources`](#list_data_sources) | <code>knowledge_base_id: str</code> | <code>ListDataSourcesOutput</code> |
| [`list_flow_aliases`](#list_flow_aliases) | <code>flow_identifier: str</code> | <code>ListFlowAliasesOutput</code> |
| [`list_flow_versions`](#list_flow_versions) | <code>flow_identifier: str</code> | <code>ListFlowVersionsOutput</code> |
| [`list_flows`](#list_flows) | None | <code>ListFlowsOutput</code> |
| [`list_ingestion_jobs`](#list_ingestion_jobs) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code> | <code>ListIngestionJobsOutput</code> |
| [`list_knowledge_base_documents`](#list_knowledge_base_documents) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code> | <code>ListKnowledgeBaseDocumentsOutput</code> |
| [`list_knowledge_bases`](#list_knowledge_bases) | None | <code>ListKnowledgeBasesOutput</code> |
| [`list_prompts`](#list_prompts) | None | <code>ListPromptsOutput</code> |
| [`list_retrieval_instruction_versions`](#list_retrieval_instruction_versions) | <code>retrieval_instruction_id: str</code> | <code>ListRetrievalInstructionVersionsOutput</code> |
| [`list_retrieval_instructions`](#list_retrieval_instructions) | None | <code>ListRetrievalInstructionsOutput</code> |
| [`list_tags_for_resource`](#list_tags_for_resource) | <code>resource_arn: str</code> | <code>ListTagsForResourceOutput</code> |
| [`list_vpc_configurations`](#list_vpc_configurations) | <code>knowledge_base_id: str</code> | <code>ListVpcConfigurationsOutput</code> |
| [`prepare_agent`](#prepare_agent) | <code>agent_id: str</code> | <code>PrepareAgentOutput</code> |
| [`prepare_flow`](#prepare_flow) | <code>flow_identifier: str</code> | <code>PrepareFlowOutput</code> |
| [`put_resource_policy`](#put_resource_policy) | <code>resource_arn: str</code>, <code>policy: str</code> | <code>PutResourcePolicyOutput</code> |
| [`start_ingestion_job`](#start_ingestion_job) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code> | <code>StartIngestionJobOutput</code> |
| [`stop_ingestion_job`](#stop_ingestion_job) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>ingestion_job_id: str</code> | <code>StopIngestionJobOutput</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_agent`](#update_agent) | <code>agent_id: str</code>, <code>agent_name: str</code>, <code>foundation_model: str</code>, <code>agent_resource_role_arn: str</code> | <code>UpdateAgentOutput</code> |
| [`update_agent_action_group`](#update_agent_action_group) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>action_group_id: str</code>, <code>action_group_name: str</code> | <code>UpdateAgentActionGroupOutput</code> |
| [`update_agent_alias`](#update_agent_alias) | <code>agent_id: str</code>, <code>agent_alias_id: str</code>, <code>agent_alias_name: str</code> | <code>UpdateAgentAliasOutput</code> |
| [`update_agent_collaborator`](#update_agent_collaborator) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>collaborator_id: str</code>, <code>agent_descriptor: AgentDescriptor</code>, <code>collaborator_name: str</code>, <code>collaboration_instruction: str</code> | <code>UpdateAgentCollaboratorOutput</code> |
| [`update_agent_knowledge_base`](#update_agent_knowledge_base) | <code>agent_id: str</code>, <code>agent_version: str</code>, <code>knowledge_base_id: str</code> | <code>UpdateAgentKnowledgeBaseOutput</code> |
| [`update_data_source`](#update_data_source) | <code>knowledge_base_id: str</code>, <code>data_source_id: str</code>, <code>name: str</code>, <code>data_source_configuration: DataSourceConfiguration</code> | <code>UpdateDataSourceOutput</code> |
| [`update_flow`](#update_flow) | <code>name: str</code>, <code>execution_role_arn: str</code>, <code>flow_identifier: str</code> | <code>UpdateFlowOutput</code> |
| [`update_flow_alias`](#update_flow_alias) | <code>name: str</code>, <code>routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem]</code>, <code>flow_identifier: str</code>, <code>alias_identifier: str</code> | <code>UpdateFlowAliasOutput</code> |
| [`update_knowledge_base`](#update_knowledge_base) | <code>knowledge_base_id: str</code>, <code>name: str</code>, <code>role_arn: str</code>, <code>knowledge_base_configuration: KnowledgeBaseConfiguration</code> | <code>UpdateKnowledgeBaseOutput</code> |
| [`update_prompt`](#update_prompt) | <code>name: str</code>, <code>prompt_identifier: str</code> | <code>UpdatePromptOutput</code> |
| [`update_retrieval_instruction`](#update_retrieval_instruction) | <code>retrieval_instruction_id: str</code>, <code>instruction: RetrievalInstructionContent</code> | <code>UpdateRetrievalInstructionOutput</code> |
| [`validate_flow_definition`](#validate_flow_definition) | <code>definition: FlowDefinition</code> | <code>ValidateFlowDefinitionOutput</code> |

## Complete signatures

### associate_agent_collaborator

```python
async def associate_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    agent_descriptor: AgentDescriptor,
    collaborator_name: str,
    collaboration_instruction: str,
    relay_conversation_history: RelayConversationHistory | None = None,
    client_token: str | None = None,
) -> AssociateAgentCollaboratorOutput: ...
```


### associate_agent_knowledge_base

```python
async def associate_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
    description: str,
    knowledge_base_state: KnowledgeBaseState | None = None,
) -> AssociateAgentKnowledgeBaseOutput: ...
```


### create_agent

```python
async def create_agent(
    *,
    agent_name: str,
    client_token: str | None = None,
    instruction: str | None = None,
    foundation_model: str | None = None,
    description: str | None = None,
    orchestration_type: OrchestrationType | None = None,
    custom_orchestration: CustomOrchestration | None = None,
    idle_session_ttl_in_seconds: int | None = None,
    agent_resource_role_arn: str | None = None,
    customer_encryption_key_arn: str | None = None,
    tags: dict[str, str] | None = None,
    prompt_override_configuration: PromptOverrideConfiguration | None = None,
    guardrail_configuration: GuardrailConfiguration | None = None,
    memory_configuration: MemoryConfiguration | None = None,
    agent_collaboration: AgentCollaboration | None = None,
) -> CreateAgentOutput: ...
```


### create_agent_action_group

```python
async def create_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_name: str,
    client_token: str | None = None,
    description: str | None = None,
    parent_action_group_signature: ActionGroupSignature | None = None,
    parent_action_group_signature_params: dict[str, str] | None = None,
    action_group_executor: ActionGroupExecutor | None = None,
    api_schema: APISchema | None = None,
    action_group_state: ActionGroupState | None = None,
    function_schema: FunctionSchema | None = None,
) -> CreateAgentActionGroupOutput: ...
```


### create_agent_alias

```python
async def create_agent_alias(
    *,
    agent_id: str,
    agent_alias_name: str,
    client_token: str | None = None,
    description: str | None = None,
    routing_configuration: Sequence[AgentAliasRoutingConfigurationListItem] | None = None,
    tags: dict[str, str] | None = None,
) -> CreateAgentAliasOutput: ...
```


### create_data_source

```python
async def create_data_source(
    *,
    knowledge_base_id: str,
    name: str,
    data_source_configuration: DataSourceConfiguration,
    client_token: str | None = None,
    description: str | None = None,
    data_deletion_policy: DataDeletionPolicy | None = None,
    server_side_encryption_configuration: ServerSideEncryptionConfiguration | None = None,
    vector_ingestion_configuration: VectorIngestionConfiguration | None = None,
) -> CreateDataSourceOutput: ...
```


### create_flow

```python
async def create_flow(
    *,
    name: str,
    execution_role_arn: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    definition: FlowDefinition | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateFlowOutput: ...
```


### create_flow_alias

```python
async def create_flow_alias(
    *,
    name: str,
    routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem],
    flow_identifier: str,
    description: str | None = None,
    concurrency_configuration: FlowAliasConcurrencyConfiguration | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateFlowAliasOutput: ...
```


### create_flow_version

```python
async def create_flow_version(
    *,
    flow_identifier: str,
    description: str | None = None,
    client_token: str | None = None,
) -> CreateFlowVersionOutput: ...
```


### create_knowledge_base

```python
async def create_knowledge_base(
    *,
    name: str,
    role_arn: str,
    knowledge_base_configuration: KnowledgeBaseConfiguration,
    client_token: str | None = None,
    description: str | None = None,
    storage_configuration: StorageConfiguration | None = None,
    tags: dict[str, str] | None = None,
) -> CreateKnowledgeBaseOutput: ...
```


### create_prompt

```python
async def create_prompt(
    *,
    name: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    default_variant: str | None = None,
    variants: Sequence[PromptVariant] | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreatePromptOutput: ...
```


### create_prompt_version

```python
async def create_prompt_version(
    *,
    prompt_identifier: str,
    description: str | None = None,
    client_token: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreatePromptVersionOutput: ...
```


### create_retrieval_instruction

```python
async def create_retrieval_instruction(
    *,
    name: str,
    instruction: RetrievalInstructionContent,
    client_token: str | None = None,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    tags: dict[str, str] | None = None,
) -> CreateRetrievalInstructionOutput: ...
```


### create_retrieval_instruction_version

```python
async def create_retrieval_instruction_version(
    *,
    retrieval_instruction_id: str,
    description: str | None = None,
    client_token: str | None = None,
) -> CreateRetrievalInstructionVersionOutput: ...
```


### create_vpc_configuration

```python
async def create_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_id: str,
    subnet_ids: Sequence[str],
    resource_target: str,
    port: int,
    protocol: VpcProtocol,
    resolution_mode: VpcResolutionMode,
    client_token: str | None = None,
    host_header: str | None = None,
    tls_server_name: str | None = None,
    name: str | None = None,
    description: str | None = None,
) -> CreateVpcConfigurationOutput: ...
```


### delete_agent

```python
async def delete_agent(
    *,
    agent_id: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentOutput: ...
```


### delete_agent_action_group

```python
async def delete_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentActionGroupOutput: ...
```


### delete_agent_alias

```python
async def delete_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
) -> DeleteAgentAliasOutput: ...
```


### delete_agent_version

```python
async def delete_agent_version(
    *,
    agent_id: str,
    agent_version: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteAgentVersionOutput: ...
```


### delete_data_source

```python
async def delete_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
) -> DeleteDataSourceOutput: ...
```


### delete_flow

```python
async def delete_flow(
    *,
    flow_identifier: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteFlowOutput: ...
```


### delete_flow_alias

```python
async def delete_flow_alias(
    *,
    flow_identifier: str,
    alias_identifier: str,
) -> DeleteFlowAliasOutput: ...
```


### delete_flow_version

```python
async def delete_flow_version(
    *,
    flow_identifier: str,
    flow_version: str,
    skip_resource_in_use_check: bool | None = None,
) -> DeleteFlowVersionOutput: ...
```


### delete_knowledge_base

```python
async def delete_knowledge_base(
    *,
    knowledge_base_id: str,
) -> DeleteKnowledgeBaseOutput: ...
```


### delete_knowledge_base_documents

```python
async def delete_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    document_identifiers: Sequence[DocumentIdentifier],
    client_token: str | None = None,
) -> DeleteKnowledgeBaseDocumentsOutput: ...
```


### delete_prompt

```python
async def delete_prompt(
    *,
    prompt_identifier: str,
    prompt_version: str | None = None,
) -> DeletePromptOutput: ...
```


### delete_resource_policy

```python
async def delete_resource_policy(
    *,
    resource_arn: str,
    expected_revision_id: str | None = None,
) -> DeleteResourcePolicyOutput: ...
```


### delete_retrieval_instruction

```python
async def delete_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    retrieval_instruction_version: str | None = None,
) -> DeleteRetrievalInstructionOutput: ...
```


### delete_vpc_configuration

```python
async def delete_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_configuration_id: str,
) -> DeleteVpcConfigurationOutput: ...
```


### disassociate_agent_collaborator

```python
async def disassociate_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
) -> DisassociateAgentCollaboratorOutput: ...
```


### disassociate_agent_knowledge_base

```python
async def disassociate_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
) -> DisassociateAgentKnowledgeBaseOutput: ...
```


### get_agent

```python
async def get_agent(
    *,
    agent_id: str,
) -> GetAgentOutput: ...
```


### get_agent_action_group

```python
async def get_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
) -> GetAgentActionGroupOutput: ...
```


### get_agent_alias

```python
async def get_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
) -> GetAgentAliasOutput: ...
```


### get_agent_collaborator

```python
async def get_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
) -> GetAgentCollaboratorOutput: ...
```


### get_agent_knowledge_base

```python
async def get_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
) -> GetAgentKnowledgeBaseOutput: ...
```


### get_agent_version

```python
async def get_agent_version(
    *,
    agent_id: str,
    agent_version: str,
) -> GetAgentVersionOutput: ...
```


### get_data_source

```python
async def get_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
) -> GetDataSourceOutput: ...
```


### get_flow

```python
async def get_flow(
    *,
    flow_identifier: str,
    included_data: IncludedData | None = None,
) -> GetFlowOutput: ...
```


### get_flow_alias

```python
async def get_flow_alias(
    *,
    flow_identifier: str,
    alias_identifier: str,
) -> GetFlowAliasOutput: ...
```


### get_flow_version

```python
async def get_flow_version(
    *,
    flow_identifier: str,
    flow_version: str,
    included_data: IncludedData | None = None,
) -> GetFlowVersionOutput: ...
```


### get_ingestion_job

```python
async def get_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    ingestion_job_id: str,
) -> GetIngestionJobOutput: ...
```


### get_knowledge_base

```python
async def get_knowledge_base(
    *,
    knowledge_base_id: str,
) -> GetKnowledgeBaseOutput: ...
```


### get_knowledge_base_documents

```python
async def get_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    document_identifiers: Sequence[DocumentIdentifier],
) -> GetKnowledgeBaseDocumentsOutput: ...
```


### get_prompt

```python
async def get_prompt(
    *,
    prompt_identifier: str,
    prompt_version: str | None = None,
    included_data: IncludedData | None = None,
) -> GetPromptOutput: ...
```


### get_resource_policy

```python
async def get_resource_policy(
    *,
    resource_arn: str,
) -> GetResourcePolicyOutput: ...
```


### get_retrieval_instruction

```python
async def get_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    retrieval_instruction_version: str | None = None,
) -> GetRetrievalInstructionOutput: ...
```


### get_vpc_configuration

```python
async def get_vpc_configuration(
    *,
    knowledge_base_id: str,
    vpc_configuration_id: str,
) -> GetVpcConfigurationOutput: ...
```


### ingest_knowledge_base_documents

```python
async def ingest_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    documents: Sequence[KnowledgeBaseDocument],
    client_token: str | None = None,
) -> IngestKnowledgeBaseDocumentsOutput: ...
```


### list_agent_action_groups

```python
async def list_agent_action_groups(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentActionGroupsOutput: ...
```

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


### list_agent_aliases

```python
async def list_agent_aliases(
    *,
    agent_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentAliasesOutput: ...
```

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


### list_agent_collaborators

```python
async def list_agent_collaborators(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentCollaboratorsOutput: ...
```

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


### list_agent_knowledge_bases

```python
async def list_agent_knowledge_bases(
    *,
    agent_id: str,
    agent_version: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentKnowledgeBasesOutput: ...
```

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


### list_agent_versions

```python
async def list_agent_versions(
    *,
    agent_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentVersionsOutput: ...
```

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


### list_agents

```python
async def list_agents(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListAgentsOutput: ...
```

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


### list_data_sources

```python
async def list_data_sources(
    *,
    knowledge_base_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListDataSourcesOutput: ...
```

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


### list_flow_aliases

```python
async def list_flow_aliases(
    *,
    flow_identifier: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowAliasesOutput: ...
```

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


### list_flow_versions

```python
async def list_flow_versions(
    *,
    flow_identifier: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowVersionsOutput: ...
```

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


### list_flows

```python
async def list_flows(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListFlowsOutput: ...
```

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


### list_ingestion_jobs

```python
async def list_ingestion_jobs(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    filters: Sequence[IngestionJobFilter] | None = None,
    sort_by: IngestionJobSortBy | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListIngestionJobsOutput: ...
```

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


### list_knowledge_base_documents

```python
async def list_knowledge_base_documents(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListKnowledgeBaseDocumentsOutput: ...
```

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


### list_knowledge_bases

```python
async def list_knowledge_bases(
    *,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListKnowledgeBasesOutput: ...
```

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


### list_prompts

```python
async def list_prompts(
    *,
    prompt_identifier: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListPromptsOutput: ...
```

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


### list_retrieval_instruction_versions

```python
async def list_retrieval_instruction_versions(
    *,
    retrieval_instruction_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListRetrievalInstructionVersionsOutput: ...
```

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


### list_retrieval_instructions

```python
async def list_retrieval_instructions(
    *,
    status: RetrievalInstructionStatus | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListRetrievalInstructionsOutput: ...
```

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


### list_tags_for_resource

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


### list_vpc_configurations

```python
async def list_vpc_configurations(
    *,
    knowledge_base_id: str,
    status_filter: VpcConfigurationStatus | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListVpcConfigurationsOutput: ...
```

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


### prepare_agent

```python
async def prepare_agent(
    *,
    agent_id: str,
) -> PrepareAgentOutput: ...
```


### prepare_flow

```python
async def prepare_flow(
    *,
    flow_identifier: str,
) -> PrepareFlowOutput: ...
```


### put_resource_policy

```python
async def put_resource_policy(
    *,
    resource_arn: str,
    policy: str,
    expected_revision_id: str | None = None,
) -> PutResourcePolicyOutput: ...
```


### start_ingestion_job

```python
async def start_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    client_token: str | None = None,
    description: str | None = None,
) -> StartIngestionJobOutput: ...
```


### stop_ingestion_job

```python
async def stop_ingestion_job(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    ingestion_job_id: str,
) -> StopIngestionJobOutput: ...
```


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

```python
async def update_agent(
    *,
    agent_id: str,
    agent_name: str,
    foundation_model: str,
    agent_resource_role_arn: str,
    instruction: str | None = None,
    description: str | None = None,
    orchestration_type: OrchestrationType | None = None,
    custom_orchestration: CustomOrchestration | None = None,
    idle_session_ttl_in_seconds: int | None = None,
    customer_encryption_key_arn: str | None = None,
    prompt_override_configuration: PromptOverrideConfiguration | None = None,
    guardrail_configuration: GuardrailConfiguration | None = None,
    memory_configuration: MemoryConfiguration | None = None,
    agent_collaboration: AgentCollaboration | None = None,
) -> UpdateAgentOutput: ...
```


### update_agent_action_group

```python
async def update_agent_action_group(
    *,
    agent_id: str,
    agent_version: str,
    action_group_id: str,
    action_group_name: str,
    description: str | None = None,
    parent_action_group_signature: ActionGroupSignature | None = None,
    parent_action_group_signature_params: dict[str, str] | None = None,
    action_group_executor: ActionGroupExecutor | None = None,
    action_group_state: ActionGroupState | None = None,
    api_schema: APISchema | None = None,
    function_schema: FunctionSchema | None = None,
) -> UpdateAgentActionGroupOutput: ...
```


### update_agent_alias

```python
async def update_agent_alias(
    *,
    agent_id: str,
    agent_alias_id: str,
    agent_alias_name: str,
    description: str | None = None,
    routing_configuration: Sequence[AgentAliasRoutingConfigurationListItem] | None = None,
    alias_invocation_state: AliasInvocationState | None = None,
) -> UpdateAgentAliasOutput: ...
```


### update_agent_collaborator

```python
async def update_agent_collaborator(
    *,
    agent_id: str,
    agent_version: str,
    collaborator_id: str,
    agent_descriptor: AgentDescriptor,
    collaborator_name: str,
    collaboration_instruction: str,
    relay_conversation_history: RelayConversationHistory | None = None,
) -> UpdateAgentCollaboratorOutput: ...
```


### update_agent_knowledge_base

```python
async def update_agent_knowledge_base(
    *,
    agent_id: str,
    agent_version: str,
    knowledge_base_id: str,
    description: str | None = None,
    knowledge_base_state: KnowledgeBaseState | None = None,
) -> UpdateAgentKnowledgeBaseOutput: ...
```


### update_data_source

```python
async def update_data_source(
    *,
    knowledge_base_id: str,
    data_source_id: str,
    name: str,
    data_source_configuration: DataSourceConfiguration,
    description: str | None = None,
    data_deletion_policy: DataDeletionPolicy | None = None,
    server_side_encryption_configuration: ServerSideEncryptionConfiguration | None = None,
    vector_ingestion_configuration: VectorIngestionConfiguration | None = None,
) -> UpdateDataSourceOutput: ...
```


### update_flow

```python
async def update_flow(
    *,
    name: str,
    execution_role_arn: str,
    flow_identifier: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    definition: FlowDefinition | None = None,
) -> UpdateFlowOutput: ...
```


### update_flow_alias

```python
async def update_flow_alias(
    *,
    name: str,
    routing_configuration: Sequence[FlowAliasRoutingConfigurationListItem],
    flow_identifier: str,
    alias_identifier: str,
    description: str | None = None,
    concurrency_configuration: FlowAliasConcurrencyConfiguration | None = None,
) -> UpdateFlowAliasOutput: ...
```


### update_knowledge_base

```python
async def update_knowledge_base(
    *,
    knowledge_base_id: str,
    name: str,
    role_arn: str,
    knowledge_base_configuration: KnowledgeBaseConfiguration,
    description: str | None = None,
    storage_configuration: StorageConfiguration | None = None,
) -> UpdateKnowledgeBaseOutput: ...
```


### update_prompt

```python
async def update_prompt(
    *,
    name: str,
    prompt_identifier: str,
    description: str | None = None,
    customer_encryption_key_arn: str | None = None,
    default_variant: str | None = None,
    variants: Sequence[PromptVariant] | None = None,
) -> UpdatePromptOutput: ...
```


### update_retrieval_instruction

```python
async def update_retrieval_instruction(
    *,
    retrieval_instruction_id: str,
    instruction: RetrievalInstructionContent,
    description: str | None = None,
) -> UpdateRetrievalInstructionOutput: ...
```


### validate_flow_definition

```python
async def validate_flow_definition(
    *,
    definition: FlowDefinition,
) -> ValidateFlowDefinitionOutput: ...
```


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

