QBusinessClient

Index > QBusiness > QBusinessClient

Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.

QBusinessClient

Type annotations and code completion for boto3.client("qbusiness"). boto3 documentation

# QBusinessClient usage example

from boto3.session import Session
from mypy_boto3_qbusiness.client import QBusinessClient

def get_qbusiness_client() -> QBusinessClient:
    return Session().client("qbusiness")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("qbusiness").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("qbusiness")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.LicenseNotFoundException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_qbusiness.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

batch_delete_document

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").batch_delete_document method. boto3 documentation

# batch_delete_document method definition

def batch_delete_document(
    self,
    *,
    applicationId: str,
    documents: Sequence[DeleteDocumentTypeDef],  # (1)
    indexId: str,
    dataSourceSyncId: str = ...,
) -> BatchDeleteDocumentResponseTypeDef:  # (2)
    ...

1. See DeleteDocumentTypeDef
2. See BatchDeleteDocumentResponseTypeDef

# batch_delete_document method usage example with argument unpacking

kwargs: BatchDeleteDocumentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "documents": ...,
    "indexId": ...,
}

parent.batch_delete_document(**kwargs)

1. See BatchDeleteDocumentRequestRequestTypeDef

batch_put_document

Adds one or more documents to an Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").batch_put_document method. boto3 documentation

# batch_put_document method definition

def batch_put_document(
    self,
    *,
    applicationId: str,
    documents: Sequence[DocumentTypeDef],  # (1)
    indexId: str,
    dataSourceSyncId: str = ...,
    roleArn: str = ...,
) -> BatchPutDocumentResponseTypeDef:  # (2)
    ...

1. See DocumentTypeDef
2. See BatchPutDocumentResponseTypeDef

# batch_put_document method usage example with argument unpacking

kwargs: BatchPutDocumentRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "documents": ...,
    "indexId": ...,
}

parent.batch_put_document(**kwargs)

1. See BatchPutDocumentRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("qbusiness").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

chat_sync

Starts or continues a non-streaming Amazon Q Business conversation.

Type annotations and code completion for boto3.client("qbusiness").chat_sync method. boto3 documentation

# chat_sync method definition

def chat_sync(
    self,
    *,
    applicationId: str,
    actionExecution: Union[ActionExecutionTypeDef, ActionExecutionExtraOutputTypeDef] = ...,  # (1)
    attachments: Sequence[AttachmentInputTypeDef] = ...,  # (2)
    attributeFilter: AttributeFilterTypeDef = ...,  # (3)
    chatMode: ChatModeType = ...,  # (4)
    chatModeConfiguration: ChatModeConfigurationTypeDef = ...,  # (5)
    clientToken: str = ...,
    conversationId: str = ...,
    parentMessageId: str = ...,
    userGroups: Sequence[str] = ...,
    userId: str = ...,
    userMessage: str = ...,
) -> ChatSyncOutputTypeDef:  # (6)
    ...

1. See ActionExecutionTypeDef ActionExecutionExtraOutputTypeDef
2. See AttachmentInputTypeDef
3. See AttributeFilterTypeDef
4. See ChatModeType
5. See ChatModeConfigurationTypeDef
6. See ChatSyncOutputTypeDef

# chat_sync method usage example with argument unpacking

kwargs: ChatSyncInputRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.chat_sync(**kwargs)

1. See ChatSyncInputRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("qbusiness").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_application

Creates an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    displayName: str,
    roleArn: str,
    attachmentsConfiguration: AttachmentsConfigurationTypeDef = ...,  # (1)
    clientToken: str = ...,
    description: str = ...,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
    identityCenterInstanceArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateApplicationResponseTypeDef:  # (4)
    ...

1. See AttachmentsConfigurationTypeDef
2. See EncryptionConfigurationTypeDef
3. See TagTypeDef
4. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "displayName": ...,
    "roleArn": ...,
}

parent.create_application(**kwargs)

1. See CreateApplicationRequestRequestTypeDef

create_data_source

Creates a data source connector for an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").create_data_source method. boto3 documentation

# create_data_source method definition

def create_data_source(
    self,
    *,
    applicationId: str,
    configuration: Mapping[str, Any],
    displayName: str,
    indexId: str,
    clientToken: str = ...,
    description: str = ...,
    documentEnrichmentConfiguration: Union[DocumentEnrichmentConfigurationTypeDef, DocumentEnrichmentConfigurationOutputTypeDef] = ...,  # (1)
    roleArn: str = ...,
    syncSchedule: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    vpcConfiguration: Union[DataSourceVpcConfigurationTypeDef, DataSourceVpcConfigurationOutputTypeDef] = ...,  # (3)
) -> CreateDataSourceResponseTypeDef:  # (4)
    ...

1. See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef
2. See TagTypeDef
3. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
4. See CreateDataSourceResponseTypeDef

# create_data_source method usage example with argument unpacking

kwargs: CreateDataSourceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "configuration": ...,
    "displayName": ...,
    "indexId": ...,
}

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestRequestTypeDef

create_index

Creates an Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").create_index method. boto3 documentation

# create_index method definition

def create_index(
    self,
    *,
    applicationId: str,
    displayName: str,
    capacityConfiguration: IndexCapacityConfigurationTypeDef = ...,  # (1)
    clientToken: str = ...,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateIndexResponseTypeDef:  # (3)
    ...

1. See IndexCapacityConfigurationTypeDef
2. See TagTypeDef
3. See CreateIndexResponseTypeDef

# create_index method usage example with argument unpacking

kwargs: CreateIndexRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "displayName": ...,
}

parent.create_index(**kwargs)

1. See CreateIndexRequestRequestTypeDef

create_plugin

Creates an Amazon Q Business plugin.

Type annotations and code completion for boto3.client("qbusiness").create_plugin method. boto3 documentation

# create_plugin method definition

def create_plugin(
    self,
    *,
    applicationId: str,
    authConfiguration: PluginAuthConfigurationTypeDef,  # (1)
    displayName: str,
    serverUrl: str,
    type: PluginTypeType,  # (2)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreatePluginResponseTypeDef:  # (4)
    ...

1. See PluginAuthConfigurationTypeDef
2. See PluginTypeType
3. See TagTypeDef
4. See CreatePluginResponseTypeDef

# create_plugin method usage example with argument unpacking

kwargs: CreatePluginRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "authConfiguration": ...,
    "displayName": ...,
    "serverUrl": ...,
    "type": ...,
}

parent.create_plugin(**kwargs)

1. See CreatePluginRequestRequestTypeDef

create_retriever

Adds a retriever to your Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").create_retriever method. boto3 documentation

# create_retriever method definition

def create_retriever(
    self,
    *,
    applicationId: str,
    configuration: Union[RetrieverConfigurationTypeDef, RetrieverConfigurationOutputTypeDef],  # (1)
    displayName: str,
    type: RetrieverTypeType,  # (2)
    clientToken: str = ...,
    roleArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRetrieverResponseTypeDef:  # (4)
    ...

1. See RetrieverConfigurationTypeDef RetrieverConfigurationOutputTypeDef
2. See RetrieverTypeType
3. See TagTypeDef
4. See CreateRetrieverResponseTypeDef

# create_retriever method usage example with argument unpacking

kwargs: CreateRetrieverRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "configuration": ...,
    "displayName": ...,
    "type": ...,
}

parent.create_retriever(**kwargs)

1. See CreateRetrieverRequestRequestTypeDef

create_user

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

Type annotations and code completion for boto3.client("qbusiness").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    applicationId: str,
    userId: str,
    clientToken: str = ...,
    userAliases: Sequence[UserAliasTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See UserAliasTypeDef

# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestRequestTypeDef

create_web_experience

Creates an Amazon Q Business web experience.

Type annotations and code completion for boto3.client("qbusiness").create_web_experience method. boto3 documentation

# create_web_experience method definition

def create_web_experience(
    self,
    *,
    applicationId: str,
    clientToken: str = ...,
    roleArn: str = ...,
    samplePromptsControlMode: WebExperienceSamplePromptsControlModeType = ...,  # (1)
    subtitle: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    title: str = ...,
    welcomeMessage: str = ...,
) -> CreateWebExperienceResponseTypeDef:  # (3)
    ...

1. See WebExperienceSamplePromptsControlModeType
2. See TagTypeDef
3. See CreateWebExperienceResponseTypeDef

# create_web_experience method usage example with argument unpacking

kwargs: CreateWebExperienceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.create_web_experience(**kwargs)

1. See CreateWebExperienceRequestRequestTypeDef

delete_application

Deletes an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...

# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)

1. See DeleteApplicationRequestRequestTypeDef

delete_chat_controls_configuration

Deletes chat controls configured for an existing Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").delete_chat_controls_configuration method. boto3 documentation

# delete_chat_controls_configuration method definition

def delete_chat_controls_configuration(
    self,
    *,
    applicationId: str,
) -> Dict[str, Any]:
    ...

# delete_chat_controls_configuration method usage example with argument unpacking

kwargs: DeleteChatControlsConfigurationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_chat_controls_configuration(**kwargs)

1. See DeleteChatControlsConfigurationRequestRequestTypeDef

delete_conversation

Deletes an Amazon Q Business web experience conversation.

Type annotations and code completion for boto3.client("qbusiness").delete_conversation method. boto3 documentation

# delete_conversation method definition

def delete_conversation(
    self,
    *,
    applicationId: str,
    conversationId: str,
    userId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_conversation method usage example with argument unpacking

kwargs: DeleteConversationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "conversationId": ...,
}

parent.delete_conversation(**kwargs)

1. See DeleteConversationRequestRequestTypeDef

delete_data_source

Deletes an Amazon Q Business data source connector.

Type annotations and code completion for boto3.client("qbusiness").delete_data_source method. boto3 documentation

# delete_data_source method definition

def delete_data_source(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
) -> Dict[str, Any]:
    ...

# delete_data_source method usage example with argument unpacking

kwargs: DeleteDataSourceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestRequestTypeDef

delete_group

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

Type annotations and code completion for boto3.client("qbusiness").delete_group method. boto3 documentation

# delete_group method definition

def delete_group(
    self,
    *,
    applicationId: str,
    groupName: str,
    indexId: str,
    dataSourceId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_group method usage example with argument unpacking

kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "groupName": ...,
    "indexId": ...,
}

parent.delete_group(**kwargs)

1. See DeleteGroupRequestRequestTypeDef

delete_index

Deletes an Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").delete_index method. boto3 documentation

# delete_index method definition

def delete_index(
    self,
    *,
    applicationId: str,
    indexId: str,
) -> Dict[str, Any]:
    ...

# delete_index method usage example with argument unpacking

kwargs: DeleteIndexRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.delete_index(**kwargs)

1. See DeleteIndexRequestRequestTypeDef

delete_plugin

Deletes an Amazon Q Business plugin.

Type annotations and code completion for boto3.client("qbusiness").delete_plugin method. boto3 documentation

# delete_plugin method definition

def delete_plugin(
    self,
    *,
    applicationId: str,
    pluginId: str,
) -> Dict[str, Any]:
    ...

# delete_plugin method usage example with argument unpacking

kwargs: DeletePluginRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "pluginId": ...,
}

parent.delete_plugin(**kwargs)

1. See DeletePluginRequestRequestTypeDef

delete_retriever

Deletes the retriever used by an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").delete_retriever method. boto3 documentation

# delete_retriever method definition

def delete_retriever(
    self,
    *,
    applicationId: str,
    retrieverId: str,
) -> Dict[str, Any]:
    ...

# delete_retriever method usage example with argument unpacking

kwargs: DeleteRetrieverRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "retrieverId": ...,
}

parent.delete_retriever(**kwargs)

1. See DeleteRetrieverRequestRequestTypeDef

delete_user

Deletes a user by email id.

Type annotations and code completion for boto3.client("qbusiness").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    applicationId: str,
    userId: str,
) -> Dict[str, Any]:
    ...

# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.delete_user(**kwargs)

1. See DeleteUserRequestRequestTypeDef

delete_web_experience

Deletes an Amazon Q Business web experience.

Type annotations and code completion for boto3.client("qbusiness").delete_web_experience method. boto3 documentation

# delete_web_experience method definition

def delete_web_experience(
    self,
    *,
    applicationId: str,
    webExperienceId: str,
) -> Dict[str, Any]:
    ...

# delete_web_experience method usage example with argument unpacking

kwargs: DeleteWebExperienceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "webExperienceId": ...,
}

parent.delete_web_experience(**kwargs)

1. See DeleteWebExperienceRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("qbusiness").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_application

Gets information about an existing Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    applicationId: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...

1. See GetApplicationResponseTypeDef

# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationRequestRequestTypeDef

get_chat_controls_configuration

Gets information about an chat controls configured for an existing Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").get_chat_controls_configuration method. boto3 documentation

# get_chat_controls_configuration method definition

def get_chat_controls_configuration(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetChatControlsConfigurationResponseTypeDef:  # (1)
    ...

1. See GetChatControlsConfigurationResponseTypeDef

# get_chat_controls_configuration method usage example with argument unpacking

kwargs: GetChatControlsConfigurationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_chat_controls_configuration(**kwargs)

1. See GetChatControlsConfigurationRequestRequestTypeDef

get_data_source

Gets information about an existing Amazon Q Business data source connector.

Type annotations and code completion for boto3.client("qbusiness").get_data_source method. boto3 documentation

# get_data_source method definition

def get_data_source(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
) -> GetDataSourceResponseTypeDef:  # (1)
    ...

1. See GetDataSourceResponseTypeDef

# get_data_source method usage example with argument unpacking

kwargs: GetDataSourceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestRequestTypeDef

get_group

Describes a group by group name.

Type annotations and code completion for boto3.client("qbusiness").get_group method. boto3 documentation

# get_group method definition

def get_group(
    self,
    *,
    applicationId: str,
    groupName: str,
    indexId: str,
    dataSourceId: str = ...,
) -> GetGroupResponseTypeDef:  # (1)
    ...

1. See GetGroupResponseTypeDef

# get_group method usage example with argument unpacking

kwargs: GetGroupRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "groupName": ...,
    "indexId": ...,
}

parent.get_group(**kwargs)

1. See GetGroupRequestRequestTypeDef

get_index

Gets information about an existing Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").get_index method. boto3 documentation

# get_index method definition

def get_index(
    self,
    *,
    applicationId: str,
    indexId: str,
) -> GetIndexResponseTypeDef:  # (1)
    ...

1. See GetIndexResponseTypeDef

# get_index method usage example with argument unpacking

kwargs: GetIndexRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.get_index(**kwargs)

1. See GetIndexRequestRequestTypeDef

get_plugin

Gets information about an existing Amazon Q Business plugin.

Type annotations and code completion for boto3.client("qbusiness").get_plugin method. boto3 documentation

# get_plugin method definition

def get_plugin(
    self,
    *,
    applicationId: str,
    pluginId: str,
) -> GetPluginResponseTypeDef:  # (1)
    ...

1. See GetPluginResponseTypeDef

# get_plugin method usage example with argument unpacking

kwargs: GetPluginRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "pluginId": ...,
}

parent.get_plugin(**kwargs)

1. See GetPluginRequestRequestTypeDef

get_retriever

Gets information about an existing retriever used by an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").get_retriever method. boto3 documentation

# get_retriever method definition

def get_retriever(
    self,
    *,
    applicationId: str,
    retrieverId: str,
) -> GetRetrieverResponseTypeDef:  # (1)
    ...

1. See GetRetrieverResponseTypeDef

# get_retriever method usage example with argument unpacking

kwargs: GetRetrieverRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "retrieverId": ...,
}

parent.get_retriever(**kwargs)

1. See GetRetrieverRequestRequestTypeDef

get_user

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Type annotations and code completion for boto3.client("qbusiness").get_user method. boto3 documentation

# get_user method definition

def get_user(
    self,
    *,
    applicationId: str,
    userId: str,
) -> GetUserResponseTypeDef:  # (1)
    ...

1. See GetUserResponseTypeDef

# get_user method usage example with argument unpacking

kwargs: GetUserRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.get_user(**kwargs)

1. See GetUserRequestRequestTypeDef

get_web_experience

Gets information about an existing Amazon Q Business web experience.

Type annotations and code completion for boto3.client("qbusiness").get_web_experience method. boto3 documentation

# get_web_experience method definition

def get_web_experience(
    self,
    *,
    applicationId: str,
    webExperienceId: str,
) -> GetWebExperienceResponseTypeDef:  # (1)
    ...

1. See GetWebExperienceResponseTypeDef

# get_web_experience method usage example with argument unpacking

kwargs: GetWebExperienceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "webExperienceId": ...,
}

parent.get_web_experience(**kwargs)

1. See GetWebExperienceRequestRequestTypeDef

list_applications

Lists Amazon Q Business applications.

Type annotations and code completion for boto3.client("qbusiness").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationsResponseTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsRequestRequestTypeDef

list_conversations

Lists one or more Amazon Q Business conversations.

Type annotations and code completion for boto3.client("qbusiness").list_conversations method. boto3 documentation

# list_conversations method definition

def list_conversations(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    userId: str = ...,
) -> ListConversationsResponseTypeDef:  # (1)
    ...

1. See ListConversationsResponseTypeDef

# list_conversations method usage example with argument unpacking

kwargs: ListConversationsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_conversations(**kwargs)

1. See ListConversationsRequestRequestTypeDef

list_data_source_sync_jobs

Get information about an Amazon Q Business data source connector synchronization.

Type annotations and code completion for boto3.client("qbusiness").list_data_source_sync_jobs method. boto3 documentation

# list_data_source_sync_jobs method definition

def list_data_source_sync_jobs(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
    endTime: Union[datetime, str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    startTime: Union[datetime, str] = ...,
    statusFilter: DataSourceSyncJobStatusType = ...,  # (1)
) -> ListDataSourceSyncJobsResponseTypeDef:  # (2)
    ...

1. See DataSourceSyncJobStatusType
2. See ListDataSourceSyncJobsResponseTypeDef

# list_data_source_sync_jobs method usage example with argument unpacking

kwargs: ListDataSourceSyncJobsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.list_data_source_sync_jobs(**kwargs)

1. See ListDataSourceSyncJobsRequestRequestTypeDef

list_data_sources

Lists the Amazon Q Business data source connectors that you have created.

Type annotations and code completion for boto3.client("qbusiness").list_data_sources method. boto3 documentation

# list_data_sources method definition

def list_data_sources(
    self,
    *,
    applicationId: str,
    indexId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...

1. See ListDataSourcesResponseTypeDef

# list_data_sources method usage example with argument unpacking

kwargs: ListDataSourcesRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestRequestTypeDef

list_documents

A list of documents attached to an index.

Type annotations and code completion for boto3.client("qbusiness").list_documents method. boto3 documentation

# list_documents method definition

def list_documents(
    self,
    *,
    applicationId: str,
    indexId: str,
    dataSourceIds: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDocumentsResponseTypeDef:  # (1)
    ...

1. See ListDocumentsResponseTypeDef

# list_documents method usage example with argument unpacking

kwargs: ListDocumentsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.list_documents(**kwargs)

1. See ListDocumentsRequestRequestTypeDef

list_groups

Provides a list of groups that are mapped to users.

Type annotations and code completion for boto3.client("qbusiness").list_groups method. boto3 documentation

# list_groups method definition

def list_groups(
    self,
    *,
    applicationId: str,
    indexId: str,
    updatedEarlierThan: Union[datetime, str],
    dataSourceId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...

1. See ListGroupsResponseTypeDef

# list_groups method usage example with argument unpacking

kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
    "updatedEarlierThan": ...,
}

parent.list_groups(**kwargs)

1. See ListGroupsRequestRequestTypeDef

list_indices

Lists the Amazon Q Business indices you have created.

Type annotations and code completion for boto3.client("qbusiness").list_indices method. boto3 documentation

# list_indices method definition

def list_indices(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListIndicesResponseTypeDef:  # (1)
    ...

1. See ListIndicesResponseTypeDef

# list_indices method usage example with argument unpacking

kwargs: ListIndicesRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_indices(**kwargs)

1. See ListIndicesRequestRequestTypeDef

list_messages

Gets a list of messages associated with an Amazon Q Business web experience.

Type annotations and code completion for boto3.client("qbusiness").list_messages method. boto3 documentation

# list_messages method definition

def list_messages(
    self,
    *,
    applicationId: str,
    conversationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    userId: str = ...,
) -> ListMessagesResponseTypeDef:  # (1)
    ...

1. See ListMessagesResponseTypeDef

# list_messages method usage example with argument unpacking

kwargs: ListMessagesRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "conversationId": ...,
}

parent.list_messages(**kwargs)

1. See ListMessagesRequestRequestTypeDef

list_plugins

Lists configured Amazon Q Business plugins.

Type annotations and code completion for boto3.client("qbusiness").list_plugins method. boto3 documentation

# list_plugins method definition

def list_plugins(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListPluginsResponseTypeDef:  # (1)
    ...

1. See ListPluginsResponseTypeDef

# list_plugins method usage example with argument unpacking

kwargs: ListPluginsRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_plugins(**kwargs)

1. See ListPluginsRequestRequestTypeDef

list_retrievers

Lists the retriever used by an Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").list_retrievers method. boto3 documentation

# list_retrievers method definition

def list_retrievers(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRetrieversResponseTypeDef:  # (1)
    ...

1. See ListRetrieversResponseTypeDef

# list_retrievers method usage example with argument unpacking

kwargs: ListRetrieversRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_retrievers(**kwargs)

1. See ListRetrieversRequestRequestTypeDef

list_tags_for_resource

Gets a list of tags associated with a specified resource.

Type annotations and code completion for boto3.client("qbusiness").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_web_experiences

Lists one or more Amazon Q Business Web Experiences.

Type annotations and code completion for boto3.client("qbusiness").list_web_experiences method. boto3 documentation

# list_web_experiences method definition

def list_web_experiences(
    self,
    *,
    applicationId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWebExperiencesResponseTypeDef:  # (1)
    ...

1. See ListWebExperiencesResponseTypeDef

# list_web_experiences method usage example with argument unpacking

kwargs: ListWebExperiencesRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.list_web_experiences(**kwargs)

1. See ListWebExperiencesRequestRequestTypeDef

put_feedback

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

Type annotations and code completion for boto3.client("qbusiness").put_feedback method. boto3 documentation

# put_feedback method definition

def put_feedback(
    self,
    *,
    applicationId: str,
    conversationId: str,
    messageId: str,
    messageCopiedAt: Union[datetime, str] = ...,
    messageUsefulness: MessageUsefulnessFeedbackTypeDef = ...,  # (1)
    userId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See MessageUsefulnessFeedbackTypeDef
2. See EmptyResponseMetadataTypeDef

# put_feedback method usage example with argument unpacking

kwargs: PutFeedbackRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "conversationId": ...,
    "messageId": ...,
}

parent.put_feedback(**kwargs)

1. See PutFeedbackRequestRequestTypeDef

put_group

Create, or updates, a mapping of users—who have access to a document—to groups.

Type annotations and code completion for boto3.client("qbusiness").put_group method. boto3 documentation

# put_group method definition

def put_group(
    self,
    *,
    applicationId: str,
    groupMembers: GroupMembersTypeDef,  # (1)
    groupName: str,
    indexId: str,
    type: MembershipTypeType,  # (2)
    dataSourceId: str = ...,
) -> Dict[str, Any]:
    ...

1. See GroupMembersTypeDef
2. See MembershipTypeType

# put_group method usage example with argument unpacking

kwargs: PutGroupRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "groupMembers": ...,
    "groupName": ...,
    "indexId": ...,
    "type": ...,
}

parent.put_group(**kwargs)

1. See PutGroupRequestRequestTypeDef

start_data_source_sync_job

Starts a data source connector synchronization job.

Type annotations and code completion for boto3.client("qbusiness").start_data_source_sync_job method. boto3 documentation

# start_data_source_sync_job method definition

def start_data_source_sync_job(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
) -> StartDataSourceSyncJobResponseTypeDef:  # (1)
    ...

1. See StartDataSourceSyncJobResponseTypeDef

# start_data_source_sync_job method usage example with argument unpacking

kwargs: StartDataSourceSyncJobRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.start_data_source_sync_job(**kwargs)

1. See StartDataSourceSyncJobRequestRequestTypeDef

stop_data_source_sync_job

Stops an Amazon Q Business data source connector synchronization job already in progress.

Type annotations and code completion for boto3.client("qbusiness").stop_data_source_sync_job method. boto3 documentation

# stop_data_source_sync_job method definition

def stop_data_source_sync_job(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
) -> Dict[str, Any]:
    ...

# stop_data_source_sync_job method usage example with argument unpacking

kwargs: StopDataSourceSyncJobRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.stop_data_source_sync_job(**kwargs)

1. See StopDataSourceSyncJobRequestRequestTypeDef

tag_resource

Adds the specified tag to the specified Amazon Q Business application or data source resource.

Type annotations and code completion for boto3.client("qbusiness").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceARN: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from an Amazon Q Business application or a data source.

Type annotations and code completion for boto3.client("qbusiness").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceARN: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_application

Updates an existing Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    applicationId: str,
    attachmentsConfiguration: AttachmentsConfigurationTypeDef = ...,  # (1)
    description: str = ...,
    displayName: str = ...,
    roleArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See AttachmentsConfigurationTypeDef

# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.update_application(**kwargs)

1. See UpdateApplicationRequestRequestTypeDef

update_chat_controls_configuration

Updates an set of chat controls configured for an existing Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").update_chat_controls_configuration method. boto3 documentation

# update_chat_controls_configuration method definition

def update_chat_controls_configuration(
    self,
    *,
    applicationId: str,
    blockedPhrasesConfigurationUpdate: BlockedPhrasesConfigurationUpdateTypeDef = ...,  # (1)
    clientToken: str = ...,
    creatorModeConfiguration: CreatorModeConfigurationTypeDef = ...,  # (2)
    responseScope: ResponseScopeType = ...,  # (3)
    topicConfigurationsToCreateOrUpdate: Sequence[Union[TopicConfigurationTypeDef, TopicConfigurationExtraOutputTypeDef]] = ...,  # (4)
    topicConfigurationsToDelete: Sequence[Union[TopicConfigurationTypeDef, TopicConfigurationExtraOutputTypeDef]] = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See BlockedPhrasesConfigurationUpdateTypeDef
2. See CreatorModeConfigurationTypeDef
3. See ResponseScopeType
4. See TopicConfigurationTypeDef TopicConfigurationExtraOutputTypeDef
5. See TopicConfigurationTypeDef TopicConfigurationExtraOutputTypeDef

# update_chat_controls_configuration method usage example with argument unpacking

kwargs: UpdateChatControlsConfigurationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.update_chat_controls_configuration(**kwargs)

1. See UpdateChatControlsConfigurationRequestRequestTypeDef

update_data_source

Updates an existing Amazon Q Business data source connector.

Type annotations and code completion for boto3.client("qbusiness").update_data_source method. boto3 documentation

# update_data_source method definition

def update_data_source(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
    configuration: Mapping[str, Any] = ...,
    description: str = ...,
    displayName: str = ...,
    documentEnrichmentConfiguration: Union[DocumentEnrichmentConfigurationTypeDef, DocumentEnrichmentConfigurationOutputTypeDef] = ...,  # (1)
    roleArn: str = ...,
    syncSchedule: str = ...,
    vpcConfiguration: Union[DataSourceVpcConfigurationTypeDef, DataSourceVpcConfigurationOutputTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef
2. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef

# update_data_source method usage example with argument unpacking

kwargs: UpdateDataSourceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestRequestTypeDef

update_index

Updates an Amazon Q Business index.

Type annotations and code completion for boto3.client("qbusiness").update_index method. boto3 documentation

# update_index method definition

def update_index(
    self,
    *,
    applicationId: str,
    indexId: str,
    capacityConfiguration: IndexCapacityConfigurationTypeDef = ...,  # (1)
    description: str = ...,
    displayName: str = ...,
    documentAttributeConfigurations: Sequence[DocumentAttributeConfigurationTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See IndexCapacityConfigurationTypeDef
2. See DocumentAttributeConfigurationTypeDef

# update_index method usage example with argument unpacking

kwargs: UpdateIndexRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.update_index(**kwargs)

1. See UpdateIndexRequestRequestTypeDef

update_plugin

Updates an Amazon Q Business plugin.

Type annotations and code completion for boto3.client("qbusiness").update_plugin method. boto3 documentation

# update_plugin method definition

def update_plugin(
    self,
    *,
    applicationId: str,
    pluginId: str,
    authConfiguration: PluginAuthConfigurationTypeDef = ...,  # (1)
    displayName: str = ...,
    serverUrl: str = ...,
    state: PluginStateType = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See PluginAuthConfigurationTypeDef
2. See PluginStateType

# update_plugin method usage example with argument unpacking

kwargs: UpdatePluginRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "pluginId": ...,
}

parent.update_plugin(**kwargs)

1. See UpdatePluginRequestRequestTypeDef

update_retriever

Updates the retriever used for your Amazon Q Business application.

Type annotations and code completion for boto3.client("qbusiness").update_retriever method. boto3 documentation

# update_retriever method definition

def update_retriever(
    self,
    *,
    applicationId: str,
    retrieverId: str,
    configuration: Union[RetrieverConfigurationTypeDef, RetrieverConfigurationOutputTypeDef] = ...,  # (1)
    displayName: str = ...,
    roleArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See RetrieverConfigurationTypeDef RetrieverConfigurationOutputTypeDef

# update_retriever method usage example with argument unpacking

kwargs: UpdateRetrieverRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "retrieverId": ...,
}

parent.update_retriever(**kwargs)

1. See UpdateRetrieverRequestRequestTypeDef

update_user

Updates a information associated with a user id.

Type annotations and code completion for boto3.client("qbusiness").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    applicationId: str,
    userId: str,
    userAliasesToDelete: Sequence[UserAliasTypeDef] = ...,  # (1)
    userAliasesToUpdate: Sequence[UserAliasTypeDef] = ...,  # (1)
) -> UpdateUserResponseTypeDef:  # (3)
    ...

1. See UserAliasTypeDef
2. See UserAliasTypeDef
3. See UpdateUserResponseTypeDef

# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestRequestTypeDef

update_web_experience

Updates an Amazon Q Business web experience.

Type annotations and code completion for boto3.client("qbusiness").update_web_experience method. boto3 documentation

# update_web_experience method definition

def update_web_experience(
    self,
    *,
    applicationId: str,
    webExperienceId: str,
    authenticationConfiguration: WebExperienceAuthConfigurationTypeDef = ...,  # (1)
    samplePromptsControlMode: WebExperienceSamplePromptsControlModeType = ...,  # (2)
    subtitle: str = ...,
    title: str = ...,
    welcomeMessage: str = ...,
) -> Dict[str, Any]:
    ...

1. See WebExperienceAuthConfigurationTypeDef
2. See WebExperienceSamplePromptsControlModeType

# update_web_experience method usage example with argument unpacking

kwargs: UpdateWebExperienceRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
    "webExperienceId": ...,
}

parent.update_web_experience(**kwargs)

1. See UpdateWebExperienceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("qbusiness").get_paginator method with overloads.

• client.get_paginator("get_chat_controls_configuration") -> GetChatControlsConfigurationPaginator
• client.get_paginator("list_applications") -> ListApplicationsPaginator
• client.get_paginator("list_conversations") -> ListConversationsPaginator
• client.get_paginator("list_data_source_sync_jobs") -> ListDataSourceSyncJobsPaginator
• client.get_paginator("list_data_sources") -> ListDataSourcesPaginator
• client.get_paginator("list_documents") -> ListDocumentsPaginator
• client.get_paginator("list_groups") -> ListGroupsPaginator
• client.get_paginator("list_indices") -> ListIndicesPaginator
• client.get_paginator("list_messages") -> ListMessagesPaginator
• client.get_paginator("list_plugins") -> ListPluginsPaginator
• client.get_paginator("list_retrievers") -> ListRetrieversPaginator
• client.get_paginator("list_web_experiences") -> ListWebExperiencesPaginator