Skip to content

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 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 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 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,
    userId: str,
    actionExecution: ActionExecutionTypeDef = ...,  # (1)
    attachments: Sequence[AttachmentInputTypeDef] = ...,  # (2)
    attributeFilter: AttributeFilterTypeDef = ...,  # (3)
    clientToken: str = ...,
    conversationId: str = ...,
    parentMessageId: str = ...,
    userGroups: Sequence[str] = ...,
    userMessage: str = ...,
) -> ChatSyncOutputTypeDef:  # (4)
    ...
  1. See ActionExecutionTypeDef
  2. See AttachmentInputTypeDef
  3. See AttributeFilterTypeDef
  4. See ChatSyncOutputTypeDef
# chat_sync method usage example with argument unpacking

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

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 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)
    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 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: DocumentEnrichmentConfigurationTypeDef = ...,  # (1)
    roleArn: str = ...,
    syncSchedule: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    vpcConfiguration: DataSourceVpcConfigurationTypeDef = ...,  # (3)
) -> CreateDataSourceResponseTypeDef:  # (4)
    ...
  1. See DocumentEnrichmentConfigurationTypeDef
  2. See TagTypeDef
  3. See DataSourceVpcConfigurationTypeDef
  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 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 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 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: RetrieverConfigurationTypeDef,  # (1)
    displayName: str,
    type: RetrieverTypeType,  # (2)
    clientToken: str = ...,
    roleArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRetrieverResponseTypeDef:  # (4)
    ...
  1. See RetrieverConfigurationTypeDef
  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 web experience.

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