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

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 Q Business**,
powered by Rust. This package contains `QBusinessClient` and
**83 operations**.

## Installation

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

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

You can also install `rboto-qbusiness` 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 QBusinessClient


async def main() -> None:
    client = QBusinessClient(region="us-east-1")
    response = await client.chat_sync(
        application_id="YOUR_APPLICATION_ID",
        user_id="YOUR_USER_ID",
        user_message="Where is our onboarding guide?",
    )
    print(response.system_message)


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

| Method | Required arguments | Return type |
|---|---|---|
| [`associate_permission`](#associate_permission) | <code>application_id: str</code>, <code>statement_id: str</code>, <code>actions: Sequence[str]</code>, <code>principal: str</code> | <code>AssociatePermissionOutput</code> |
| [`batch_delete_document`](#batch_delete_document) | <code>application_id: str</code>, <code>index_id: str</code>, <code>documents: Sequence[DeleteDocument]</code> | <code>BatchDeleteDocumentOutput</code> |
| [`batch_put_document`](#batch_put_document) | <code>application_id: str</code>, <code>index_id: str</code>, <code>documents: Sequence[Document]</code> | <code>BatchPutDocumentOutput</code> |
| [`cancel_subscription`](#cancel_subscription) | <code>application_id: str</code>, <code>subscription_id: str</code> | <code>CancelSubscriptionOutput</code> |
| [`chat`](#chat) | <code>application_id: str</code> | <code>ChatOutput</code> |
| [`chat_sync`](#chat_sync) | <code>application_id: str</code> | <code>ChatSyncOutput</code> |
| [`check_document_access`](#check_document_access) | <code>application_id: str</code>, <code>index_id: str</code>, <code>user_id: str</code>, <code>document_id: str</code> | <code>CheckDocumentAccessOutput</code> |
| [`create_anonymous_web_experience_url`](#create_anonymous_web_experience_url) | <code>application_id: str</code>, <code>web_experience_id: str</code> | <code>CreateAnonymousWebExperienceUrlOutput</code> |
| [`create_application`](#create_application) | <code>display_name: str</code> | <code>CreateApplicationOutput</code> |
| [`create_chat_response_configuration`](#create_chat_response_configuration) | <code>application_id: str</code>, <code>display_name: str</code>, <code>response_configurations: dict[ResponseConfigurationType, ResponseConfiguration]</code> | <code>CreateChatResponseConfigurationOutput</code> |
| [`create_data_accessor`](#create_data_accessor) | <code>application_id: str</code>, <code>principal: str</code>, <code>action_configurations: Sequence[ActionConfiguration]</code>, <code>display_name: str</code> | <code>CreateDataAccessorOutput</code> |
| [`create_data_source`](#create_data_source) | <code>application_id: str</code>, <code>index_id: str</code>, <code>display_name: str</code>, <code>configuration: JSONValue</code> | <code>CreateDataSourceOutput</code> |
| [`create_index`](#create_index) | <code>application_id: str</code>, <code>display_name: str</code> | <code>CreateIndexOutput</code> |
| [`create_plugin`](#create_plugin) | <code>application_id: str</code>, <code>display_name: str</code>, <code>type: PluginType</code>, <code>auth_configuration: PluginAuthConfiguration</code> | <code>CreatePluginOutput</code> |
| [`create_retriever`](#create_retriever) | <code>application_id: str</code>, <code>type: RetrieverType</code>, <code>display_name: str</code>, <code>configuration: RetrieverConfiguration</code> | <code>CreateRetrieverOutput</code> |
| [`create_subscription`](#create_subscription) | <code>application_id: str</code>, <code>principal: SubscriptionPrincipal</code>, <code>type: SubscriptionType</code> | <code>CreateSubscriptionOutput</code> |
| [`create_user`](#create_user) | <code>application_id: str</code>, <code>user_id: str</code> | <code>CreateUserOutput</code> |
| [`create_web_experience`](#create_web_experience) | <code>application_id: str</code> | <code>CreateWebExperienceOutput</code> |
| [`delete_application`](#delete_application) | <code>application_id: str</code> | <code>DeleteApplicationOutput</code> |
| [`delete_attachment`](#delete_attachment) | <code>application_id: str</code>, <code>conversation_id: str</code>, <code>attachment_id: str</code> | <code>DeleteAttachmentOutput</code> |
| [`delete_chat_controls_configuration`](#delete_chat_controls_configuration) | <code>application_id: str</code> | <code>DeleteChatControlsConfigurationOutput</code> |
| [`delete_chat_response_configuration`](#delete_chat_response_configuration) | <code>application_id: str</code>, <code>chat_response_configuration_id: str</code> | <code>DeleteChatResponseConfigurationOutput</code> |
| [`delete_conversation`](#delete_conversation) | <code>conversation_id: str</code>, <code>application_id: str</code> | <code>DeleteConversationOutput</code> |
| [`delete_data_accessor`](#delete_data_accessor) | <code>application_id: str</code>, <code>data_accessor_id: str</code> | <code>DeleteDataAccessorOutput</code> |
| [`delete_data_source`](#delete_data_source) | <code>application_id: str</code>, <code>index_id: str</code>, <code>data_source_id: str</code> | <code>DeleteDataSourceOutput</code> |
| [`delete_group`](#delete_group) | <code>application_id: str</code>, <code>index_id: str</code>, <code>group_name: str</code> | <code>DeleteGroupOutput</code> |
| [`delete_index`](#delete_index) | <code>application_id: str</code>, <code>index_id: str</code> | <code>DeleteIndexOutput</code> |
| [`delete_plugin`](#delete_plugin) | <code>application_id: str</code>, <code>plugin_id: str</code> | <code>DeletePluginOutput</code> |
| [`delete_retriever`](#delete_retriever) | <code>application_id: str</code>, <code>retriever_id: str</code> | <code>DeleteRetrieverOutput</code> |
| [`delete_user`](#delete_user) | <code>application_id: str</code>, <code>user_id: str</code> | <code>DeleteUserOutput</code> |
| [`delete_web_experience`](#delete_web_experience) | <code>application_id: str</code>, <code>web_experience_id: str</code> | <code>DeleteWebExperienceOutput</code> |
| [`disassociate_permission`](#disassociate_permission) | <code>application_id: str</code>, <code>statement_id: str</code> | <code>DisassociatePermissionOutput</code> |
| [`get_application`](#get_application) | <code>application_id: str</code> | <code>GetApplicationOutput</code> |
| [`get_chat_controls_configuration`](#get_chat_controls_configuration) | <code>application_id: str</code> | <code>GetChatControlsConfigurationOutput</code> |
| [`get_chat_response_configuration`](#get_chat_response_configuration) | <code>application_id: str</code>, <code>chat_response_configuration_id: str</code> | <code>GetChatResponseConfigurationOutput</code> |
| [`get_data_accessor`](#get_data_accessor) | <code>application_id: str</code>, <code>data_accessor_id: str</code> | <code>GetDataAccessorOutput</code> |
| [`get_data_source`](#get_data_source) | <code>application_id: str</code>, <code>index_id: str</code>, <code>data_source_id: str</code> | <code>GetDataSourceOutput</code> |
| [`get_document_content`](#get_document_content) | <code>application_id: str</code>, <code>index_id: str</code>, <code>document_id: str</code> | <code>GetDocumentContentOutput</code> |
| [`get_group`](#get_group) | <code>application_id: str</code>, <code>index_id: str</code>, <code>group_name: str</code> | <code>GetGroupOutput</code> |
| [`get_index`](#get_index) | <code>application_id: str</code>, <code>index_id: str</code> | <code>GetIndexOutput</code> |
| [`get_media`](#get_media) | <code>application_id: str</code>, <code>conversation_id: str</code>, <code>message_id: str</code>, <code>media_id: str</code> | <code>GetMediaOutput</code> |
| [`get_plugin`](#get_plugin) | <code>application_id: str</code>, <code>plugin_id: str</code> | <code>GetPluginOutput</code> |
| [`get_policy`](#get_policy) | <code>application_id: str</code> | <code>GetPolicyOutput</code> |
| [`get_retriever`](#get_retriever) | <code>application_id: str</code>, <code>retriever_id: str</code> | <code>GetRetrieverOutput</code> |
| [`get_user`](#get_user) | <code>application_id: str</code>, <code>user_id: str</code> | <code>GetUserOutput</code> |
| [`get_web_experience`](#get_web_experience) | <code>application_id: str</code>, <code>web_experience_id: str</code> | <code>GetWebExperienceOutput</code> |
| [`list_applications`](#list_applications) | None | <code>ListApplicationsOutput</code> |
| [`list_attachments`](#list_attachments) | <code>application_id: str</code> | <code>ListAttachmentsOutput</code> |
| [`list_chat_response_configurations`](#list_chat_response_configurations) | <code>application_id: str</code> | <code>ListChatResponseConfigurationsOutput</code> |
| [`list_conversations`](#list_conversations) | <code>application_id: str</code> | <code>ListConversationsOutput</code> |
| [`list_data_accessors`](#list_data_accessors) | <code>application_id: str</code> | <code>ListDataAccessorsOutput</code> |
| [`list_data_source_sync_jobs`](#list_data_source_sync_jobs) | <code>data_source_id: str</code>, <code>application_id: str</code>, <code>index_id: str</code> | <code>ListDataSourceSyncJobsOutput</code> |
| [`list_data_sources`](#list_data_sources) | <code>application_id: str</code>, <code>index_id: str</code> | <code>ListDataSourcesOutput</code> |
| [`list_documents`](#list_documents) | <code>application_id: str</code>, <code>index_id: str</code> | <code>ListDocumentsOutput</code> |
| [`list_groups`](#list_groups) | <code>application_id: str</code>, <code>index_id: str</code>, <code>updated_earlier_than: str</code> | <code>ListGroupsOutput</code> |
| [`list_indices`](#list_indices) | <code>application_id: str</code> | <code>ListIndicesOutput</code> |
| [`list_messages`](#list_messages) | <code>conversation_id: str</code>, <code>application_id: str</code> | <code>ListMessagesOutput</code> |
| [`list_plugin_actions`](#list_plugin_actions) | <code>application_id: str</code>, <code>plugin_id: str</code> | <code>ListPluginActionsOutput</code> |
| [`list_plugin_type_actions`](#list_plugin_type_actions) | <code>plugin_type: PluginType</code> | <code>ListPluginTypeActionsOutput</code> |
| [`list_plugin_type_metadata`](#list_plugin_type_metadata) | None | <code>ListPluginTypeMetadataOutput</code> |
| [`list_plugins`](#list_plugins) | <code>application_id: str</code> | <code>ListPluginsOutput</code> |
| [`list_retrievers`](#list_retrievers) | <code>application_id: str</code> | <code>ListRetrieversOutput</code> |
| [`list_subscriptions`](#list_subscriptions) | <code>application_id: str</code> | <code>ListSubscriptionsOutput</code> |
| [`list_tags_for_resource`](#list_tags_for_resource) | <code>resource_arn: str</code> | <code>ListTagsForResourceOutput</code> |
| [`list_web_experiences`](#list_web_experiences) | <code>application_id: str</code> | <code>ListWebExperiencesOutput</code> |
| [`put_feedback`](#put_feedback) | <code>application_id: str</code>, <code>conversation_id: str</code>, <code>message_id: str</code> | <code>None</code> |
| [`put_group`](#put_group) | <code>application_id: str</code>, <code>index_id: str</code>, <code>group_name: str</code>, <code>type: MembershipType</code>, <code>group_members: GroupMembers</code> | <code>PutGroupOutput</code> |
| [`search_relevant_content`](#search_relevant_content) | <code>application_id: str</code>, <code>query_text: str</code>, <code>content_source: ContentSource</code> | <code>SearchRelevantContentOutput</code> |
| [`start_data_source_sync_job`](#start_data_source_sync_job) | <code>data_source_id: str</code>, <code>application_id: str</code>, <code>index_id: str</code> | <code>StartDataSourceSyncJobOutput</code> |
| [`stop_data_source_sync_job`](#stop_data_source_sync_job) | <code>data_source_id: str</code>, <code>application_id: str</code>, <code>index_id: str</code> | <code>StopDataSourceSyncJobOutput</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_application`](#update_application) | <code>application_id: str</code> | <code>UpdateApplicationOutput</code> |
| [`update_chat_controls_configuration`](#update_chat_controls_configuration) | <code>application_id: str</code> | <code>UpdateChatControlsConfigurationOutput</code> |
| [`update_chat_response_configuration`](#update_chat_response_configuration) | <code>application_id: str</code>, <code>chat_response_configuration_id: str</code>, <code>response_configurations: dict[ResponseConfigurationType, ResponseConfiguration]</code> | <code>UpdateChatResponseConfigurationOutput</code> |
| [`update_data_accessor`](#update_data_accessor) | <code>application_id: str</code>, <code>data_accessor_id: str</code>, <code>action_configurations: Sequence[ActionConfiguration]</code> | <code>UpdateDataAccessorOutput</code> |
| [`update_data_source`](#update_data_source) | <code>application_id: str</code>, <code>index_id: str</code>, <code>data_source_id: str</code> | <code>UpdateDataSourceOutput</code> |
| [`update_index`](#update_index) | <code>application_id: str</code>, <code>index_id: str</code> | <code>UpdateIndexOutput</code> |
| [`update_plugin`](#update_plugin) | <code>application_id: str</code>, <code>plugin_id: str</code> | <code>UpdatePluginOutput</code> |
| [`update_retriever`](#update_retriever) | <code>application_id: str</code>, <code>retriever_id: str</code> | <code>UpdateRetrieverOutput</code> |
| [`update_subscription`](#update_subscription) | <code>application_id: str</code>, <code>subscription_id: str</code>, <code>type: SubscriptionType</code> | <code>UpdateSubscriptionOutput</code> |
| [`update_user`](#update_user) | <code>application_id: str</code>, <code>user_id: str</code> | <code>UpdateUserOutput</code> |
| [`update_web_experience`](#update_web_experience) | <code>application_id: str</code>, <code>web_experience_id: str</code> | <code>UpdateWebExperienceOutput</code> |

## Complete signatures

### associate_permission

```python
async def associate_permission(
    *,
    application_id: str,
    statement_id: str,
    actions: Sequence[str],
    principal: str,
    conditions: Sequence[PermissionCondition] | None = None,
) -> AssociatePermissionOutput: ...
```


### batch_delete_document

```python
async def batch_delete_document(
    *,
    application_id: str,
    index_id: str,
    documents: Sequence[DeleteDocument],
    data_source_sync_id: str | None = None,
) -> BatchDeleteDocumentOutput: ...
```


### batch_put_document

```python
async def batch_put_document(
    *,
    application_id: str,
    index_id: str,
    documents: Sequence[Document],
    role_arn: str | None = None,
    data_source_sync_id: str | None = None,
) -> BatchPutDocumentOutput: ...
```


### cancel_subscription

```python
async def cancel_subscription(
    *,
    application_id: str,
    subscription_id: str,
) -> CancelSubscriptionOutput: ...
```


### chat

```python
async def chat(
    *,
    application_id: str,
    user_id: str | None = None,
    user_groups: Sequence[str] | None = None,
    conversation_id: str | None = None,
    parent_message_id: str | None = None,
    client_token: str | None = None,
    input_stream: AsyncIterator[ChatInputStream] | None = None,
) -> ChatOutput: ...
```


### chat_sync

```python
async def chat_sync(
    *,
    application_id: str,
    user_id: str | None = None,
    user_groups: Sequence[str] | None = None,
    user_message: str | None = None,
    attachments: Sequence[AttachmentInput] | None = None,
    action_execution: ActionExecution | None = None,
    auth_challenge_response: AuthChallengeResponse | None = None,
    conversation_id: str | None = None,
    parent_message_id: str | None = None,
    attribute_filter: AttributeFilter | None = None,
    chat_mode: ChatMode | None = None,
    chat_mode_configuration: ChatModeConfiguration | None = None,
    client_token: str | None = None,
) -> ChatSyncOutput: ...
```


### check_document_access

```python
async def check_document_access(
    *,
    application_id: str,
    index_id: str,
    user_id: str,
    document_id: str,
    data_source_id: str | None = None,
) -> CheckDocumentAccessOutput: ...
```


### create_anonymous_web_experience_url

```python
async def create_anonymous_web_experience_url(
    *,
    application_id: str,
    web_experience_id: str,
    session_duration_in_minutes: int | None = None,
) -> CreateAnonymousWebExperienceUrlOutput: ...
```


### create_application

```python
async def create_application(
    *,
    display_name: str,
    role_arn: str | None = None,
    identity_type: IdentityType | None = None,
    iam_identity_provider_arn: str | None = None,
    identity_center_instance_arn: str | None = None,
    client_ids_for_oidc: Sequence[str] | None = None,
    description: str | None = None,
    encryption_configuration: EncryptionConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
    client_token: str | None = None,
    attachments_configuration: AttachmentsConfiguration | None = None,
    q_apps_configuration: QAppsConfiguration | None = None,
    personalization_configuration: PersonalizationConfiguration | None = None,
    quick_sight_configuration: QuickSightConfiguration | None = None,
) -> CreateApplicationOutput: ...
```


### create_chat_response_configuration

```python
async def create_chat_response_configuration(
    *,
    application_id: str,
    display_name: str,
    response_configurations: dict[ResponseConfigurationType, ResponseConfiguration],
    client_token: str | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateChatResponseConfigurationOutput: ...
```


### create_data_accessor

```python
async def create_data_accessor(
    *,
    application_id: str,
    principal: str,
    action_configurations: Sequence[ActionConfiguration],
    display_name: str,
    client_token: str | None = None,
    authentication_detail: DataAccessorAuthenticationDetail | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateDataAccessorOutput: ...
```


### create_data_source

```python
async def create_data_source(
    *,
    application_id: str,
    index_id: str,
    display_name: str,
    configuration: JSONValue,
    vpc_configuration: DataSourceVpcConfiguration | None = None,
    description: str | None = None,
    tags: Sequence[Tag] | None = None,
    sync_schedule: str | None = None,
    role_arn: str | None = None,
    client_token: str | None = None,
    document_enrichment_configuration: DocumentEnrichmentConfiguration | None = None,
    media_extraction_configuration: MediaExtractionConfiguration | None = None,
) -> CreateDataSourceOutput: ...
```


### create_index

```python
async def create_index(
    *,
    application_id: str,
    display_name: str,
    description: str | None = None,
    type: IndexType | None = None,
    tags: Sequence[Tag] | None = None,
    capacity_configuration: IndexCapacityConfiguration | None = None,
    client_token: str | None = None,
) -> CreateIndexOutput: ...
```


### create_plugin

```python
async def create_plugin(
    *,
    application_id: str,
    display_name: str,
    type: PluginType,
    auth_configuration: PluginAuthConfiguration,
    server_url: str | None = None,
    custom_plugin_configuration: CustomPluginConfiguration | None = None,
    tags: Sequence[Tag] | None = None,
    client_token: str | None = None,
) -> CreatePluginOutput: ...
```


### create_retriever

```python
async def create_retriever(
    *,
    application_id: str,
    type: RetrieverType,
    display_name: str,
    configuration: RetrieverConfiguration,
    role_arn: str | None = None,
    client_token: str | None = None,
    tags: Sequence[Tag] | None = None,
) -> CreateRetrieverOutput: ...
```


### create_subscription

```python
async def create_subscription(
    *,
    application_id: str,
    principal: SubscriptionPrincipal,
    type: SubscriptionType,
    client_token: str | None = None,
) -> CreateSubscriptionOutput: ...
```


### create_user

```python
async def create_user(
    *,
    application_id: str,
    user_id: str,
    user_aliases: Sequence[UserAlias] | None = None,
    client_token: str | None = None,
) -> CreateUserOutput: ...
```


### create_web_experience

```python
async def create_web_experience(
    *,
    application_id: str,
    title: str | None = None,
    subtitle: str | None = None,
    welcome_message: str | None = None,
    sample_prompts_control_mode: WebExperienceSamplePromptsControlMode | None = None,
    origins: Sequence[str] | None = None,
    role_arn: str | None = None,
    tags: Sequence[Tag] | None = None,
    client_token: str | None = None,
    identity_provider_configuration: IdentityProviderConfiguration | None = None,
    browser_extension_configuration: BrowserExtensionConfiguration | None = None,
    customization_configuration: CustomizationConfiguration | None = None,
) -> CreateWebExperienceOutput: ...
```


### delete_application

```python
async def delete_application(
    *,
    application_id: str,
) -> DeleteApplicationOutput: ...
```


### delete_attachment

```python
async def delete_attachment(
    *,
    application_id: str,
    conversation_id: str,
    attachment_id: str,
    user_id: str | None = None,
) -> DeleteAttachmentOutput: ...
```


### delete_chat_controls_configuration

```python
async def delete_chat_controls_configuration(
    *,
    application_id: str,
) -> DeleteChatControlsConfigurationOutput: ...
```


### delete_chat_response_configuration

```python
async def delete_chat_response_configuration(
    *,
    application_id: str,
    chat_response_configuration_id: str,
) -> DeleteChatResponseConfigurationOutput: ...
```


### delete_conversation

```python
async def delete_conversation(
    *,
    conversation_id: str,
    application_id: str,
    user_id: str | None = None,
) -> DeleteConversationOutput: ...
```


### delete_data_accessor

```python
async def delete_data_accessor(
    *,
    application_id: str,
    data_accessor_id: str,
) -> DeleteDataAccessorOutput: ...
```


### delete_data_source

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


### delete_group

```python
async def delete_group(
    *,
    application_id: str,
    index_id: str,
    group_name: str,
    data_source_id: str | None = None,
) -> DeleteGroupOutput: ...
```


### delete_index

```python
async def delete_index(
    *,
    application_id: str,
    index_id: str,
) -> DeleteIndexOutput: ...
```


### delete_plugin

```python
async def delete_plugin(
    *,
    application_id: str,
    plugin_id: str,
) -> DeletePluginOutput: ...
```


### delete_retriever

```python
async def delete_retriever(
    *,
    application_id: str,
    retriever_id: str,
) -> DeleteRetrieverOutput: ...
```


### delete_user

```python
async def delete_user(
    *,
    application_id: str,
    user_id: str,
) -> DeleteUserOutput: ...
```


### delete_web_experience

```python
async def delete_web_experience(
    *,
    application_id: str,
    web_experience_id: str,
) -> DeleteWebExperienceOutput: ...
```


### disassociate_permission

```python
async def disassociate_permission(
    *,
    application_id: str,
    statement_id: str,
) -> DisassociatePermissionOutput: ...
```


### get_application

```python
async def get_application(
    *,
    application_id: str,
) -> GetApplicationOutput: ...
```


### get_chat_controls_configuration

```python
async def get_chat_controls_configuration(
    *,
    application_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> GetChatControlsConfigurationOutput: ...
```

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


### get_chat_response_configuration

```python
async def get_chat_response_configuration(
    *,
    application_id: str,
    chat_response_configuration_id: str,
) -> GetChatResponseConfigurationOutput: ...
```


### get_data_accessor

```python
async def get_data_accessor(
    *,
    application_id: str,
    data_accessor_id: str,
) -> GetDataAccessorOutput: ...
```


### get_data_source

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


### get_document_content

```python
async def get_document_content(
    *,
    application_id: str,
    index_id: str,
    document_id: str,
    data_source_id: str | None = None,
    output_format: OutputFormat | None = None,
) -> GetDocumentContentOutput: ...
```


### get_group

```python
async def get_group(
    *,
    application_id: str,
    index_id: str,
    group_name: str,
    data_source_id: str | None = None,
) -> GetGroupOutput: ...
```


### get_index

```python
async def get_index(
    *,
    application_id: str,
    index_id: str,
) -> GetIndexOutput: ...
```


### get_media

```python
async def get_media(
    *,
    application_id: str,
    conversation_id: str,
    message_id: str,
    media_id: str,
) -> GetMediaOutput: ...
```


### get_plugin

```python
async def get_plugin(
    *,
    application_id: str,
    plugin_id: str,
) -> GetPluginOutput: ...
```


### get_policy

```python
async def get_policy(
    *,
    application_id: str,
) -> GetPolicyOutput: ...
```


### get_retriever

```python
async def get_retriever(
    *,
    application_id: str,
    retriever_id: str,
) -> GetRetrieverOutput: ...
```


### get_user

```python
async def get_user(
    *,
    application_id: str,
    user_id: str,
) -> GetUserOutput: ...
```


### get_web_experience

```python
async def get_web_experience(
    *,
    application_id: str,
    web_experience_id: str,
) -> GetWebExperienceOutput: ...
```


### list_applications

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

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


### list_attachments

```python
async def list_attachments(
    *,
    application_id: str,
    conversation_id: str | None = None,
    user_id: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListAttachmentsOutput: ...
```

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


### list_chat_response_configurations

```python
async def list_chat_response_configurations(
    *,
    application_id: str,
    max_results: int | None = None,
    next_token: str | None = None,
) -> ListChatResponseConfigurationsOutput: ...
```

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


### list_conversations

```python
async def list_conversations(
    *,
    application_id: str,
    user_id: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListConversationsOutput: ...
```

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


### list_data_accessors

```python
async def list_data_accessors(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListDataAccessorsOutput: ...
```

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


### list_data_source_sync_jobs

```python
async def list_data_source_sync_jobs(
    *,
    data_source_id: str,
    application_id: str,
    index_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
    start_time: str | None = None,
    end_time: str | None = None,
    status_filter: DataSourceSyncJobStatus | None = None,
) -> ListDataSourceSyncJobsOutput: ...
```

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


### list_data_sources

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

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


### list_documents

```python
async def list_documents(
    *,
    application_id: str,
    index_id: str,
    data_source_ids: Sequence[str] | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListDocumentsOutput: ...
```

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


### list_groups

```python
async def list_groups(
    *,
    application_id: str,
    index_id: str,
    updated_earlier_than: str,
    data_source_id: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListGroupsOutput: ...
```

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


### list_indices

```python
async def list_indices(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListIndicesOutput: ...
```

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


### list_messages

```python
async def list_messages(
    *,
    conversation_id: str,
    application_id: str,
    user_id: str | None = None,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListMessagesOutput: ...
```

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


### list_plugin_actions

```python
async def list_plugin_actions(
    *,
    application_id: str,
    plugin_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListPluginActionsOutput: ...
```

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


### list_plugin_type_actions

```python
async def list_plugin_type_actions(
    *,
    plugin_type: PluginType,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListPluginTypeActionsOutput: ...
```

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


### list_plugin_type_metadata

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

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


### list_plugins

```python
async def list_plugins(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListPluginsOutput: ...
```

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


### list_retrievers

```python
async def list_retrievers(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListRetrieversOutput: ...
```

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


### list_subscriptions

```python
async def list_subscriptions(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListSubscriptionsOutput: ...
```

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

```python
async def list_web_experiences(
    *,
    application_id: str,
    next_token: str | None = None,
    max_results: int | None = None,
) -> ListWebExperiencesOutput: ...
```

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


### put_feedback

```python
async def put_feedback(
    *,
    application_id: str,
    conversation_id: str,
    message_id: str,
    user_id: str | None = None,
    message_copied_at: str | None = None,
    message_usefulness: MessageUsefulnessFeedback | None = None,
) -> None: ...
```


### put_group

```python
async def put_group(
    *,
    application_id: str,
    index_id: str,
    group_name: str,
    type: MembershipType,
    group_members: GroupMembers,
    data_source_id: str | None = None,
    role_arn: str | None = None,
) -> PutGroupOutput: ...
```


### search_relevant_content

```python
async def search_relevant_content(
    *,
    application_id: str,
    query_text: str,
    content_source: ContentSource,
    attribute_filter: AttributeFilter | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> SearchRelevantContentOutput: ...
```

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


### start_data_source_sync_job

```python
async def start_data_source_sync_job(
    *,
    data_source_id: str,
    application_id: str,
    index_id: str,
) -> StartDataSourceSyncJobOutput: ...
```


### stop_data_source_sync_job

```python
async def stop_data_source_sync_job(
    *,
    data_source_id: str,
    application_id: str,
    index_id: str,
) -> StopDataSourceSyncJobOutput: ...
```


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

```python
async def update_application(
    *,
    application_id: str,
    identity_center_instance_arn: str | None = None,
    display_name: str | None = None,
    description: str | None = None,
    role_arn: str | None = None,
    attachments_configuration: AttachmentsConfiguration | None = None,
    q_apps_configuration: QAppsConfiguration | None = None,
    personalization_configuration: PersonalizationConfiguration | None = None,
    auto_subscription_configuration: AutoSubscriptionConfiguration | None = None,
) -> UpdateApplicationOutput: ...
```


### update_chat_controls_configuration

```python
async def update_chat_controls_configuration(
    *,
    application_id: str,
    client_token: str | None = None,
    response_scope: ResponseScope | None = None,
    orchestration_configuration: OrchestrationConfiguration | None = None,
    blocked_phrases_configuration_update: BlockedPhrasesConfigurationUpdate | None = None,
    topic_configurations_to_create_or_update: Sequence[TopicConfiguration] | None = None,
    topic_configurations_to_delete: Sequence[TopicConfiguration] | None = None,
    creator_mode_configuration: CreatorModeConfiguration | None = None,
    hallucination_reduction_configuration: HallucinationReductionConfiguration | None = None,
) -> UpdateChatControlsConfigurationOutput: ...
```


### update_chat_response_configuration

```python
async def update_chat_response_configuration(
    *,
    application_id: str,
    chat_response_configuration_id: str,
    response_configurations: dict[ResponseConfigurationType, ResponseConfiguration],
    display_name: str | None = None,
    client_token: str | None = None,
) -> UpdateChatResponseConfigurationOutput: ...
```


### update_data_accessor

```python
async def update_data_accessor(
    *,
    application_id: str,
    data_accessor_id: str,
    action_configurations: Sequence[ActionConfiguration],
    authentication_detail: DataAccessorAuthenticationDetail | None = None,
    display_name: str | None = None,
) -> UpdateDataAccessorOutput: ...
```


### update_data_source

```python
async def update_data_source(
    *,
    application_id: str,
    index_id: str,
    data_source_id: str,
    display_name: str | None = None,
    configuration: JSONValue | None = None,
    vpc_configuration: DataSourceVpcConfiguration | None = None,
    description: str | None = None,
    sync_schedule: str | None = None,
    role_arn: str | None = None,
    document_enrichment_configuration: DocumentEnrichmentConfiguration | None = None,
    media_extraction_configuration: MediaExtractionConfiguration | None = None,
) -> UpdateDataSourceOutput: ...
```


### update_index

```python
async def update_index(
    *,
    application_id: str,
    index_id: str,
    display_name: str | None = None,
    description: str | None = None,
    capacity_configuration: IndexCapacityConfiguration | None = None,
    document_attribute_configurations: Sequence[DocumentAttributeConfiguration] | None = None,
) -> UpdateIndexOutput: ...
```


### update_plugin

```python
async def update_plugin(
    *,
    application_id: str,
    plugin_id: str,
    display_name: str | None = None,
    state: PluginState | None = None,
    server_url: str | None = None,
    custom_plugin_configuration: CustomPluginConfiguration | None = None,
    auth_configuration: PluginAuthConfiguration | None = None,
) -> UpdatePluginOutput: ...
```


### update_retriever

```python
async def update_retriever(
    *,
    application_id: str,
    retriever_id: str,
    configuration: RetrieverConfiguration | None = None,
    display_name: str | None = None,
    role_arn: str | None = None,
) -> UpdateRetrieverOutput: ...
```


### update_subscription

```python
async def update_subscription(
    *,
    application_id: str,
    subscription_id: str,
    type: SubscriptionType,
) -> UpdateSubscriptionOutput: ...
```


### update_user

```python
async def update_user(
    *,
    application_id: str,
    user_id: str,
    user_aliases_to_update: Sequence[UserAlias] | None = None,
    user_aliases_to_delete: Sequence[UserAlias] | None = None,
) -> UpdateUserOutput: ...
```


### update_web_experience

```python
async def update_web_experience(
    *,
    application_id: str,
    web_experience_id: str,
    role_arn: str | None = None,
    authentication_configuration: WebExperienceAuthConfiguration | None = None,
    title: str | None = None,
    subtitle: str | None = None,
    welcome_message: str | None = None,
    sample_prompts_control_mode: WebExperienceSamplePromptsControlMode | None = None,
    identity_provider_configuration: IdentityProviderConfiguration | None = None,
    origins: Sequence[str] | None = None,
    browser_extension_configuration: BrowserExtensionConfiguration | None = None,
    customization_configuration: CustomizationConfiguration | None = None,
) -> UpdateWebExperienceOutput: ...
```


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

