rboto-qbusiness

rboto is an independent project maintained by 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.

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.

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.

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

Complete signatures

associate_permission

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

batch_delete_document

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

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

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

chat

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

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

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

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

create_application

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

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

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

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

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

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

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

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

create_user

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

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

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

delete_attachment

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

delete_chat_controls_configuration

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

delete_chat_response_configuration

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

delete_conversation

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

delete_data_accessor

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

delete_data_source

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

delete_group

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

delete_index

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

delete_plugin

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

delete_retriever

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

delete_user

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

delete_web_experience

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

disassociate_permission

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

get_application

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

get_chat_controls_configuration

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

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

get_data_accessor

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

get_data_source

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

get_document_content

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

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

get_index

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

get_media

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

get_plugin

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

get_policy

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

get_retriever

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

get_user

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

get_web_experience

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

list_applications

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

list_web_experiences

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

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

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

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

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

stop_data_source_sync_job

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

tag_resource

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

untag_resource

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

update_application

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

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

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

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

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

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

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

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

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

update_user

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

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
• Repository
• Issues
• Releases

Licensed under Apache-2.0.