QBusinessClient

Index > QBusiness > QBusinessClient

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

QBusinessClient

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

# QBusinessClient usage example

from boto3.session import Session
from types_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.ExternalResourceException,
    client.exceptions.InternalServerException,
    client.exceptions.LicenseNotFoundException,
    client.exceptions.MediaTooLargeException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_qbusiness.client import Exceptions

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

Methods

can_paginate

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

generate_presigned_url

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

associate_permission

Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.

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

# associate_permission method definition

def associate_permission(
    self,
    *,
    applicationId: str,
    statementId: str,
    actions: Sequence[str],
    principal: str,
    conditions: Sequence[PermissionConditionTypeDef] = ...,  # (1)
) -> AssociatePermissionResponseTypeDef:  # (2)
    ...

1. See Sequence[PermissionConditionTypeDef]
2. See AssociatePermissionResponseTypeDef

# associate_permission method usage example with argument unpacking

kwargs: AssociatePermissionRequestTypeDef = {  # (1)
    "applicationId": ...,
    "statementId": ...,
    "actions": ...,
    "principal": ...,
}

parent.associate_permission(**kwargs)

1. See AssociatePermissionRequestTypeDef

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,
    indexId: str,
    documents: Sequence[DeleteDocumentTypeDef],  # (1)
    dataSourceSyncId: str = ...,
) -> BatchDeleteDocumentResponseTypeDef:  # (2)
    ...

1. See Sequence[DeleteDocumentTypeDef]
2. See BatchDeleteDocumentResponseTypeDef

# batch_delete_document method usage example with argument unpacking

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

parent.batch_delete_document(**kwargs)

1. See BatchDeleteDocumentRequestTypeDef

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,
    indexId: str,
    documents: Sequence[DocumentTypeDef],  # (1)
    roleArn: str = ...,
    dataSourceSyncId: str = ...,
) -> BatchPutDocumentResponseTypeDef:  # (2)
    ...

1. See Sequence[DocumentTypeDef]
2. See BatchPutDocumentResponseTypeDef

# batch_put_document method usage example with argument unpacking

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

parent.batch_put_document(**kwargs)

1. See BatchPutDocumentRequestTypeDef

cancel_subscription

Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application.

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

# cancel_subscription method definition

def cancel_subscription(
    self,
    *,
    applicationId: str,
    subscriptionId: str,
) -> CancelSubscriptionResponseTypeDef:  # (1)
    ...

1. See CancelSubscriptionResponseTypeDef

# cancel_subscription method usage example with argument unpacking

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

parent.cancel_subscription(**kwargs)

1. See CancelSubscriptionRequestTypeDef

chat

Starts or continues a streaming Amazon Q Business conversation.

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

# chat method definition

def chat(
    self,
    *,
    applicationId: str,
    userId: str = ...,
    userGroups: Sequence[str] = ...,
    conversationId: str = ...,
    parentMessageId: str = ...,
    clientToken: str = ...,
    inputStream: botocore.eventstream.EventStream[ChatInputStreamTypeDef] = ...,  # (1)
) -> ChatOutputTypeDef:  # (2)
    ...

1. See EventStream[ChatInputStreamTypeDef]
2. See ChatOutputTypeDef

# chat method usage example with argument unpacking

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

parent.chat(**kwargs)

1. See ChatInputTypeDef

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,
    userId: str = ...,
    userGroups: Sequence[str] = ...,
    userMessage: str = ...,
    attachments: Sequence[AttachmentInputTypeDef] = ...,  # (1)
    actionExecution: ActionExecutionUnionTypeDef = ...,  # (2)
    authChallengeResponse: AuthChallengeResponseTypeDef = ...,  # (3)
    conversationId: str = ...,
    parentMessageId: str = ...,
    attributeFilter: AttributeFilterUnionTypeDef = ...,  # (4)
    chatMode: ChatModeType = ...,  # (5)
    chatModeConfiguration: ChatModeConfigurationTypeDef = ...,  # (6)
    clientToken: str = ...,
) -> ChatSyncOutputTypeDef:  # (7)
    ...

1. See Sequence[AttachmentInputTypeDef]
2. See ActionExecutionUnionTypeDef
3. See AuthChallengeResponseTypeDef
4. See AttributeFilterUnionTypeDef
5. See ChatModeType
6. See ChatModeConfigurationTypeDef
7. See ChatSyncOutputTypeDef

# chat_sync method usage example with argument unpacking

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

parent.chat_sync(**kwargs)

1. See ChatSyncInputTypeDef

check_document_access

Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document.

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

# check_document_access method definition

def check_document_access(
    self,
    *,
    applicationId: str,
    indexId: str,
    userId: str,
    documentId: str,
    dataSourceId: str = ...,
) -> CheckDocumentAccessResponseTypeDef:  # (1)
    ...

1. See CheckDocumentAccessResponseTypeDef

# check_document_access method usage example with argument unpacking

kwargs: CheckDocumentAccessRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
    "userId": ...,
    "documentId": ...,
}

parent.check_document_access(**kwargs)

1. See CheckDocumentAccessRequestTypeDef

create_anonymous_web_experience_url

Creates a unique URL for anonymous Amazon Q Business web experience.

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

# create_anonymous_web_experience_url method definition

def create_anonymous_web_experience_url(
    self,
    *,
    applicationId: str,
    webExperienceId: str,
    sessionDurationInMinutes: int = ...,
) -> CreateAnonymousWebExperienceUrlResponseTypeDef:  # (1)
    ...

1. See CreateAnonymousWebExperienceUrlResponseTypeDef

# create_anonymous_web_experience_url method usage example with argument unpacking

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

parent.create_anonymous_web_experience_url(**kwargs)

1. See CreateAnonymousWebExperienceUrlRequestTypeDef

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 = ...,
    identityType: IdentityTypeType = ...,  # (1)
    iamIdentityProviderArn: str = ...,
    identityCenterInstanceArn: str = ...,
    clientIdsForOIDC: Sequence[str] = ...,
    description: str = ...,
    encryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
    clientToken: str = ...,
    attachmentsConfiguration: AttachmentsConfigurationTypeDef = ...,  # (4)
    qAppsConfiguration: QAppsConfigurationTypeDef = ...,  # (5)
    personalizationConfiguration: PersonalizationConfigurationTypeDef = ...,  # (6)
    quickSightConfiguration: QuickSightConfigurationTypeDef = ...,  # (7)
) -> CreateApplicationResponseTypeDef:  # (8)
    ...

1. See IdentityTypeType
2. See EncryptionConfigurationTypeDef
3. See Sequence[TagTypeDef]
4. See AttachmentsConfigurationTypeDef
5. See QAppsConfigurationTypeDef
6. See PersonalizationConfigurationTypeDef
7. See QuickSightConfigurationTypeDef
8. See CreateApplicationResponseTypeDef

# create_application method usage example with argument unpacking

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

parent.create_application(**kwargs)

1. See CreateApplicationRequestTypeDef

create_chat_response_configuration

Creates a new chat response configuration for an Amazon Q Business application.

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

# create_chat_response_configuration method definition

def create_chat_response_configuration(
    self,
    *,
    applicationId: str,
    displayName: str,
    responseConfigurations: Mapping[ResponseConfigurationTypeType, ResponseConfigurationTypeDef],  # (1)
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateChatResponseConfigurationResponseTypeDef:  # (3)
    ...

1. See Mapping[Literal['ALL'], ResponseConfigurationTypeDef]
2. See Sequence[TagTypeDef]
3. See CreateChatResponseConfigurationResponseTypeDef

# create_chat_response_configuration method usage example with argument unpacking

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

parent.create_chat_response_configuration(**kwargs)

1. See CreateChatResponseConfigurationRequestTypeDef

create_data_accessor

Creates a new data accessor for an ISV to access data from a Amazon Q Business application.

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

# create_data_accessor method definition

def create_data_accessor(
    self,
    *,
    applicationId: str,
    principal: str,
    actionConfigurations: Sequence[ActionConfigurationUnionTypeDef],  # (1)
    displayName: str,
    clientToken: str = ...,
    authenticationDetail: DataAccessorAuthenticationDetailUnionTypeDef = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDataAccessorResponseTypeDef:  # (4)
    ...

1. See Sequence[ActionConfigurationUnionTypeDef]
2. See DataAccessorAuthenticationDetailUnionTypeDef
3. See Sequence[TagTypeDef]
4. See CreateDataAccessorResponseTypeDef

# create_data_accessor method usage example with argument unpacking

kwargs: CreateDataAccessorRequestTypeDef = {  # (1)
    "applicationId": ...,
    "principal": ...,
    "actionConfigurations": ...,
    "displayName": ...,
}

parent.create_data_accessor(**kwargs)

1. See CreateDataAccessorRequestTypeDef

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,
    indexId: str,
    displayName: str,
    configuration: Mapping[str, Any],
    vpcConfiguration: DataSourceVpcConfigurationUnionTypeDef = ...,  # (1)
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    syncSchedule: str = ...,
    roleArn: str = ...,
    clientToken: str = ...,
    documentEnrichmentConfiguration: DocumentEnrichmentConfigurationUnionTypeDef = ...,  # (3)
    mediaExtractionConfiguration: MediaExtractionConfigurationTypeDef = ...,  # (4)
) -> CreateDataSourceResponseTypeDef:  # (5)
    ...

1. See DataSourceVpcConfigurationUnionTypeDef
2. See Sequence[TagTypeDef]
3. See DocumentEnrichmentConfigurationUnionTypeDef
4. See MediaExtractionConfigurationTypeDef
5. See CreateDataSourceResponseTypeDef

# create_data_source method usage example with argument unpacking

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

parent.create_data_source(**kwargs)

1. See CreateDataSourceRequestTypeDef

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,
    description: str = ...,
    type: IndexTypeType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
    capacityConfiguration: IndexCapacityConfigurationTypeDef = ...,  # (3)
    clientToken: str = ...,
) -> CreateIndexResponseTypeDef:  # (4)
    ...

1. See IndexTypeType
2. See Sequence[TagTypeDef]
3. See IndexCapacityConfigurationTypeDef
4. See CreateIndexResponseTypeDef

# create_index method usage example with argument unpacking

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

parent.create_index(**kwargs)

1. See CreateIndexRequestTypeDef

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,
    displayName: str,
    type: PluginTypeType,  # (1)
    authConfiguration: PluginAuthConfigurationUnionTypeDef,  # (2)
    serverUrl: str = ...,
    customPluginConfiguration: CustomPluginConfigurationTypeDef = ...,  # (3)
    tags: Sequence[TagTypeDef] = ...,  # (4)
    clientToken: str = ...,
) -> CreatePluginResponseTypeDef:  # (5)
    ...

1. See PluginTypeType
2. See PluginAuthConfigurationUnionTypeDef
3. See CustomPluginConfigurationTypeDef
4. See Sequence[TagTypeDef]
5. See CreatePluginResponseTypeDef

# create_plugin method usage example with argument unpacking

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

parent.create_plugin(**kwargs)

1. See CreatePluginRequestTypeDef

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,
    type: RetrieverTypeType,  # (1)
    displayName: str,
    configuration: RetrieverConfigurationUnionTypeDef,  # (2)
    roleArn: str = ...,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateRetrieverResponseTypeDef:  # (4)
    ...

1. See RetrieverTypeType
2. See RetrieverConfigurationUnionTypeDef
3. See Sequence[TagTypeDef]
4. See CreateRetrieverResponseTypeDef

# create_retriever method usage example with argument unpacking

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

parent.create_retriever(**kwargs)

1. See CreateRetrieverRequestTypeDef

create_subscription

Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.

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

# create_subscription method definition

def create_subscription(
    self,
    *,
    applicationId: str,
    principal: SubscriptionPrincipalTypeDef,  # (1)
    type: SubscriptionTypeType,  # (2)
    clientToken: str = ...,
) -> CreateSubscriptionResponseTypeDef:  # (3)
    ...

1. See SubscriptionPrincipalTypeDef
2. See SubscriptionTypeType
3. See CreateSubscriptionResponseTypeDef

# create_subscription method usage example with argument unpacking

kwargs: CreateSubscriptionRequestTypeDef = {  # (1)
    "applicationId": ...,
    "principal": ...,
    "type": ...,
}

parent.create_subscription(**kwargs)

1. See CreateSubscriptionRequestTypeDef

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,
    userAliases: Sequence[UserAliasTypeDef] = ...,  # (1)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See Sequence[UserAliasTypeDef]

# create_user method usage example with argument unpacking

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

parent.create_user(**kwargs)

1. See CreateUserRequestTypeDef

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,
    title: str = ...,
    subtitle: str = ...,
    welcomeMessage: str = ...,
    samplePromptsControlMode: WebExperienceSamplePromptsControlModeType = ...,  # (1)
    origins: Sequence[str] = ...,
    roleArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    clientToken: str = ...,
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (3)
    browserExtensionConfiguration: BrowserExtensionConfigurationUnionTypeDef = ...,  # (4)
    customizationConfiguration: CustomizationConfigurationTypeDef = ...,  # (5)
) -> CreateWebExperienceResponseTypeDef:  # (6)
    ...

1. See WebExperienceSamplePromptsControlModeType
2. See Sequence[TagTypeDef]
3. See IdentityProviderConfigurationTypeDef
4. See BrowserExtensionConfigurationUnionTypeDef
5. See CustomizationConfigurationTypeDef
6. See CreateWebExperienceResponseTypeDef

# create_web_experience method usage example with argument unpacking

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

parent.create_web_experience(**kwargs)

1. See CreateWebExperienceRequestTypeDef

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: DeleteApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)

1. See DeleteApplicationRequestTypeDef

delete_attachment

Deletes an attachment associated with a specific Amazon Q Business conversation.

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

# delete_attachment method definition

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

# delete_attachment method usage example with argument unpacking

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

parent.delete_attachment(**kwargs)

1. See DeleteAttachmentRequestTypeDef

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: DeleteChatControlsConfigurationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_chat_controls_configuration(**kwargs)

1. See DeleteChatControlsConfigurationRequestTypeDef

delete_chat_response_configuration

Deletes a specified chat response configuration from an Amazon Q Business application.

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

# delete_chat_response_configuration method definition

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

# delete_chat_response_configuration method usage example with argument unpacking

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

parent.delete_chat_response_configuration(**kwargs)

1. See DeleteChatResponseConfigurationRequestTypeDef

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,
    *,
    conversationId: str,
    applicationId: str,
    userId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_conversation method usage example with argument unpacking

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

parent.delete_conversation(**kwargs)

1. See DeleteConversationRequestTypeDef

delete_data_accessor

Deletes a specified data accessor.

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

# delete_data_accessor method definition

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

# delete_data_accessor method usage example with argument unpacking

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

parent.delete_data_accessor(**kwargs)

1. See DeleteDataAccessorRequestTypeDef

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,
    indexId: str,
    dataSourceId: str,
) -> Dict[str, Any]:
    ...

# delete_data_source method usage example with argument unpacking

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

parent.delete_data_source(**kwargs)

1. See DeleteDataSourceRequestTypeDef

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,
    indexId: str,
    groupName: str,
    dataSourceId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_group method usage example with argument unpacking

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

parent.delete_group(**kwargs)

1. See DeleteGroupRequestTypeDef

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: DeleteIndexRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.delete_index(**kwargs)

1. See DeleteIndexRequestTypeDef

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: DeletePluginRequestTypeDef = {  # (1)
    "applicationId": ...,
    "pluginId": ...,
}

parent.delete_plugin(**kwargs)

1. See DeletePluginRequestTypeDef

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: DeleteRetrieverRequestTypeDef = {  # (1)
    "applicationId": ...,
    "retrieverId": ...,
}

parent.delete_retriever(**kwargs)

1. See DeleteRetrieverRequestTypeDef

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: DeleteUserRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.delete_user(**kwargs)

1. See DeleteUserRequestTypeDef

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: DeleteWebExperienceRequestTypeDef = {  # (1)
    "applicationId": ...,
    "webExperienceId": ...,
}

parent.delete_web_experience(**kwargs)

1. See DeleteWebExperienceRequestTypeDef

disassociate_permission

Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV.

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

# disassociate_permission method definition

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

# disassociate_permission method usage example with argument unpacking

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

parent.disassociate_permission(**kwargs)

1. See DisassociatePermissionRequestTypeDef

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: GetApplicationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_application(**kwargs)

1. See GetApplicationRequestTypeDef

get_chat_controls_configuration

Gets information about 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: GetChatControlsConfigurationRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.get_chat_controls_configuration(**kwargs)

1. See GetChatControlsConfigurationRequestTypeDef

get_chat_response_configuration

Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application.

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

# get_chat_response_configuration method definition

def get_chat_response_configuration(
    self,
    *,
    applicationId: str,
    chatResponseConfigurationId: str,
) -> GetChatResponseConfigurationResponseTypeDef:  # (1)
    ...

1. See GetChatResponseConfigurationResponseTypeDef

# get_chat_response_configuration method usage example with argument unpacking

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

parent.get_chat_response_configuration(**kwargs)

1. See GetChatResponseConfigurationRequestTypeDef

get_data_accessor

Retrieves information about a specified data accessor.

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

# get_data_accessor method definition

def get_data_accessor(
    self,
    *,
    applicationId: str,
    dataAccessorId: str,
) -> GetDataAccessorResponseTypeDef:  # (1)
    ...

1. See GetDataAccessorResponseTypeDef

# get_data_accessor method usage example with argument unpacking

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

parent.get_data_accessor(**kwargs)

1. See GetDataAccessorRequestTypeDef

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,
    indexId: str,
    dataSourceId: str,
) -> GetDataSourceResponseTypeDef:  # (1)
    ...

1. See GetDataSourceResponseTypeDef

# get_data_source method usage example with argument unpacking

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

parent.get_data_source(**kwargs)

1. See GetDataSourceRequestTypeDef

get_document_content

Retrieves the content of a document that was ingested into Amazon Q Business.

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

# get_document_content method definition

def get_document_content(
    self,
    *,
    applicationId: str,
    indexId: str,
    documentId: str,
    dataSourceId: str = ...,
    outputFormat: OutputFormatType = ...,  # (1)
) -> GetDocumentContentResponseTypeDef:  # (2)
    ...

1. See OutputFormatType
2. See GetDocumentContentResponseTypeDef

# get_document_content method usage example with argument unpacking

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

parent.get_document_content(**kwargs)

1. See GetDocumentContentRequestTypeDef

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,
    indexId: str,
    groupName: str,
    dataSourceId: str = ...,
) -> GetGroupResponseTypeDef:  # (1)
    ...

1. See GetGroupResponseTypeDef

# get_group method usage example with argument unpacking

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

parent.get_group(**kwargs)

1. See GetGroupRequestTypeDef

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: GetIndexRequestTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.get_index(**kwargs)

1. See GetIndexRequestTypeDef

get_media

Returns the image bytes corresponding to a media object.

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

# get_media method definition

def get_media(
    self,
    *,
    applicationId: str,
    conversationId: str,
    messageId: str,
    mediaId: str,
) -> GetMediaResponseTypeDef:  # (1)
    ...

1. See GetMediaResponseTypeDef

# get_media method usage example with argument unpacking

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

parent.get_media(**kwargs)

1. See GetMediaRequestTypeDef

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: GetPluginRequestTypeDef = {  # (1)
    "applicationId": ...,
    "pluginId": ...,
}

parent.get_plugin(**kwargs)

1. See GetPluginRequestTypeDef

get_policy

Retrieves the current permission policy for a Amazon Q Business application.

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

# get_policy method definition

def get_policy(
    self,
    *,
    applicationId: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...

1. See GetPolicyResponseTypeDef

# get_policy method usage example with argument unpacking

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

parent.get_policy(**kwargs)

1. See GetPolicyRequestTypeDef

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: GetRetrieverRequestTypeDef = {  # (1)
    "applicationId": ...,
    "retrieverId": ...,
}

parent.get_retriever(**kwargs)

1. See GetRetrieverRequestTypeDef

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: GetUserRequestTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.get_user(**kwargs)

1. See GetUserRequestTypeDef

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: GetWebExperienceRequestTypeDef = {  # (1)
    "applicationId": ...,
    "webExperienceId": ...,
}

parent.get_web_experience(**kwargs)

1. See GetWebExperienceRequestTypeDef

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,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...

1. See ListApplicationsResponseTypeDef

# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)

1. See ListApplicationsRequestTypeDef

list_attachments

Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

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

# list_attachments method definition

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

1. See ListAttachmentsResponseTypeDef

# list_attachments method usage example with argument unpacking

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

parent.list_attachments(**kwargs)

1. See ListAttachmentsRequestTypeDef

list_chat_response_configurations

Retrieves a list of all chat response configurations available in a specified Amazon Q Business application.

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

# list_chat_response_configurations method definition

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

1. See ListChatResponseConfigurationsResponseTypeDef

# list_chat_response_configurations method usage example with argument unpacking

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

parent.list_chat_response_configurations(**kwargs)

1. See ListChatResponseConfigurationsRequestTypeDef

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,
    userId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListConversationsResponseTypeDef:  # (1)
    ...

1. See ListConversationsResponseTypeDef

# list_conversations method usage example with argument unpacking

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

parent.list_conversations(**kwargs)

1. See ListConversationsRequestTypeDef

list_data_accessors

Lists the data accessors for a Amazon Q Business application.

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

# list_data_accessors method definition

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

1. See ListDataAccessorsResponseTypeDef

# list_data_accessors method usage example with argument unpacking

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

parent.list_data_accessors(**kwargs)

1. See ListDataAccessorsRequestTypeDef

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,
    *,
    dataSourceId: str,
    applicationId: str,
    indexId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    startTime: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
    statusFilter: DataSourceSyncJobStatusType = ...,  # (1)
) -> ListDataSourceSyncJobsResponseTypeDef:  # (2)
    ...

1. See DataSourceSyncJobStatusType
2. See ListDataSourceSyncJobsResponseTypeDef

# list_data_source_sync_jobs method usage example with argument unpacking

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

parent.list_data_source_sync_jobs(**kwargs)

1. See ListDataSourceSyncJobsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...

1. See ListDataSourcesResponseTypeDef

# list_data_sources method usage example with argument unpacking

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

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestTypeDef

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] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDocumentsResponseTypeDef:  # (1)
    ...

1. See ListDocumentsResponseTypeDef

# list_documents method usage example with argument unpacking

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

parent.list_documents(**kwargs)

1. See ListDocumentsRequestTypeDef

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: TimestampTypeDef,
    dataSourceId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...

1. See ListGroupsResponseTypeDef

# list_groups method usage example with argument unpacking

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

parent.list_groups(**kwargs)

1. See ListGroupsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIndicesResponseTypeDef:  # (1)
    ...

1. See ListIndicesResponseTypeDef

# list_indices method usage example with argument unpacking

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

parent.list_indices(**kwargs)

1. See ListIndicesRequestTypeDef

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,
    *,
    conversationId: str,
    applicationId: str,
    userId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMessagesResponseTypeDef:  # (1)
    ...

1. See ListMessagesResponseTypeDef

# list_messages method usage example with argument unpacking

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

parent.list_messages(**kwargs)

1. See ListMessagesRequestTypeDef

list_plugin_actions

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

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

# list_plugin_actions method definition

def list_plugin_actions(
    self,
    *,
    applicationId: str,
    pluginId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPluginActionsResponseTypeDef:  # (1)
    ...

1. See ListPluginActionsResponseTypeDef

# list_plugin_actions method usage example with argument unpacking

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

parent.list_plugin_actions(**kwargs)

1. See ListPluginActionsRequestTypeDef

list_plugin_type_actions

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

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

# list_plugin_type_actions method definition

def list_plugin_type_actions(
    self,
    *,
    pluginType: PluginTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPluginTypeActionsResponseTypeDef:  # (2)
    ...

1. See PluginTypeType
2. See ListPluginTypeActionsResponseTypeDef

# list_plugin_type_actions method usage example with argument unpacking

kwargs: ListPluginTypeActionsRequestTypeDef = {  # (1)
    "pluginType": ...,
}

parent.list_plugin_type_actions(**kwargs)

1. See ListPluginTypeActionsRequestTypeDef

list_plugin_type_metadata

Lists metadata for all Amazon Q Business plugin types.

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

# list_plugin_type_metadata method definition

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

1. See ListPluginTypeMetadataResponseTypeDef

# list_plugin_type_metadata method usage example with argument unpacking

kwargs: ListPluginTypeMetadataRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_plugin_type_metadata(**kwargs)

1. See ListPluginTypeMetadataRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPluginsResponseTypeDef:  # (1)
    ...

1. See ListPluginsResponseTypeDef

# list_plugins method usage example with argument unpacking

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

parent.list_plugins(**kwargs)

1. See ListPluginsRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListRetrieversResponseTypeDef:  # (1)
    ...

1. See ListRetrieversResponseTypeDef

# list_retrievers method usage example with argument unpacking

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

parent.list_retrievers(**kwargs)

1. See ListRetrieversRequestTypeDef

list_subscriptions

Lists all subscriptions created in an Amazon Q Business application.

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

# list_subscriptions method definition

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

1. See ListSubscriptionsResponseTypeDef

# list_subscriptions method usage example with argument unpacking

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

parent.list_subscriptions(**kwargs)

1. See ListSubscriptionsRequestTypeDef

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: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWebExperiencesResponseTypeDef:  # (1)
    ...

1. See ListWebExperiencesResponseTypeDef

# list_web_experiences method usage example with argument unpacking

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

parent.list_web_experiences(**kwargs)

1. See ListWebExperiencesRequestTypeDef

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,
    userId: str = ...,
    messageCopiedAt: TimestampTypeDef = ...,
    messageUsefulness: MessageUsefulnessFeedbackTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See MessageUsefulnessFeedbackTypeDef
2. See EmptyResponseMetadataTypeDef

# put_feedback method usage example with argument unpacking

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

parent.put_feedback(**kwargs)

1. See PutFeedbackRequestTypeDef

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,
    indexId: str,
    groupName: str,
    type: MembershipTypeType,  # (1)
    groupMembers: GroupMembersTypeDef,  # (2)
    dataSourceId: str = ...,
    roleArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See MembershipTypeType
2. See GroupMembersTypeDef

# put_group method usage example with argument unpacking

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

parent.put_group(**kwargs)

1. See PutGroupRequestTypeDef

search_relevant_content

Searches for relevant content in a Amazon Q Business application based on a query.

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

# search_relevant_content method definition

def search_relevant_content(
    self,
    *,
    applicationId: str,
    queryText: str,
    contentSource: ContentSourceTypeDef,  # (1)
    attributeFilter: AttributeFilterUnionTypeDef = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchRelevantContentResponseTypeDef:  # (3)
    ...

1. See ContentSourceTypeDef
2. See AttributeFilterUnionTypeDef
3. See SearchRelevantContentResponseTypeDef

# search_relevant_content method usage example with argument unpacking

kwargs: SearchRelevantContentRequestTypeDef = {  # (1)
    "applicationId": ...,
    "queryText": ...,
    "contentSource": ...,
}

parent.search_relevant_content(**kwargs)

1. See SearchRelevantContentRequestTypeDef

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,
    *,
    dataSourceId: str,
    applicationId: str,
    indexId: str,
) -> StartDataSourceSyncJobResponseTypeDef:  # (1)
    ...

1. See StartDataSourceSyncJobResponseTypeDef

# start_data_source_sync_job method usage example with argument unpacking

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

parent.start_data_source_sync_job(**kwargs)

1. See StartDataSourceSyncJobRequestTypeDef

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,
    *,
    dataSourceId: str,
    applicationId: str,
    indexId: str,
) -> Dict[str, Any]:
    ...

# stop_data_source_sync_job method usage example with argument unpacking

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

parent.stop_data_source_sync_job(**kwargs)

1. See StopDataSourceSyncJobRequestTypeDef

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 Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

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,
    identityCenterInstanceArn: str = ...,
    displayName: str = ...,
    description: str = ...,
    roleArn: str = ...,
    attachmentsConfiguration: AttachmentsConfigurationTypeDef = ...,  # (1)
    qAppsConfiguration: QAppsConfigurationTypeDef = ...,  # (2)
    personalizationConfiguration: PersonalizationConfigurationTypeDef = ...,  # (3)
    autoSubscriptionConfiguration: AutoSubscriptionConfigurationTypeDef = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See AttachmentsConfigurationTypeDef
2. See QAppsConfigurationTypeDef
3. See PersonalizationConfigurationTypeDef
4. See AutoSubscriptionConfigurationTypeDef

# update_application method usage example with argument unpacking

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

parent.update_application(**kwargs)

1. See UpdateApplicationRequestTypeDef

update_chat_controls_configuration

Updates a 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,
    clientToken: str = ...,
    responseScope: ResponseScopeType = ...,  # (1)
    orchestrationConfiguration: OrchestrationConfigurationTypeDef = ...,  # (2)
    blockedPhrasesConfigurationUpdate: BlockedPhrasesConfigurationUpdateTypeDef = ...,  # (3)
    topicConfigurationsToCreateOrUpdate: Sequence[TopicConfigurationUnionTypeDef] = ...,  # (4)
    topicConfigurationsToDelete: Sequence[TopicConfigurationUnionTypeDef] = ...,  # (4)
    creatorModeConfiguration: CreatorModeConfigurationTypeDef = ...,  # (6)
    hallucinationReductionConfiguration: HallucinationReductionConfigurationTypeDef = ...,  # (7)
) -> Dict[str, Any]:
    ...

1. See ResponseScopeType
2. See OrchestrationConfigurationTypeDef
3. See BlockedPhrasesConfigurationUpdateTypeDef
4. See Sequence[TopicConfigurationUnionTypeDef]
5. See Sequence[TopicConfigurationUnionTypeDef]
6. See CreatorModeConfigurationTypeDef
7. See HallucinationReductionConfigurationTypeDef

# update_chat_controls_configuration method usage example with argument unpacking

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

parent.update_chat_controls_configuration(**kwargs)

1. See UpdateChatControlsConfigurationRequestTypeDef

update_chat_response_configuration

Updates an existing chat response configuration in an Amazon Q Business application.

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

# update_chat_response_configuration method definition

def update_chat_response_configuration(
    self,
    *,
    applicationId: str,
    chatResponseConfigurationId: str,
    responseConfigurations: Mapping[ResponseConfigurationTypeType, ResponseConfigurationTypeDef],  # (1)
    displayName: str = ...,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See Mapping[Literal['ALL'], ResponseConfigurationTypeDef]

# update_chat_response_configuration method usage example with argument unpacking

kwargs: UpdateChatResponseConfigurationRequestTypeDef = {  # (1)
    "applicationId": ...,
    "chatResponseConfigurationId": ...,
    "responseConfigurations": ...,
}

parent.update_chat_response_configuration(**kwargs)

1. See UpdateChatResponseConfigurationRequestTypeDef

update_data_accessor

Updates an existing data accessor.

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

# update_data_accessor method definition

def update_data_accessor(
    self,
    *,
    applicationId: str,
    dataAccessorId: str,
    actionConfigurations: Sequence[ActionConfigurationUnionTypeDef],  # (1)
    authenticationDetail: DataAccessorAuthenticationDetailUnionTypeDef = ...,  # (2)
    displayName: str = ...,
) -> Dict[str, Any]:
    ...

1. See Sequence[ActionConfigurationUnionTypeDef]
2. See DataAccessorAuthenticationDetailUnionTypeDef

# update_data_accessor method usage example with argument unpacking

kwargs: UpdateDataAccessorRequestTypeDef = {  # (1)
    "applicationId": ...,
    "dataAccessorId": ...,
    "actionConfigurations": ...,
}

parent.update_data_accessor(**kwargs)

1. See UpdateDataAccessorRequestTypeDef

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,
    indexId: str,
    dataSourceId: str,
    displayName: str = ...,
    configuration: Mapping[str, Any] = ...,
    vpcConfiguration: DataSourceVpcConfigurationUnionTypeDef = ...,  # (1)
    description: str = ...,
    syncSchedule: str = ...,
    roleArn: str = ...,
    documentEnrichmentConfiguration: DocumentEnrichmentConfigurationUnionTypeDef = ...,  # (2)
    mediaExtractionConfiguration: MediaExtractionConfigurationTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...

1. See DataSourceVpcConfigurationUnionTypeDef
2. See DocumentEnrichmentConfigurationUnionTypeDef
3. See MediaExtractionConfigurationTypeDef

# update_data_source method usage example with argument unpacking

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

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestTypeDef

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,
    displayName: str = ...,
    description: str = ...,
    capacityConfiguration: IndexCapacityConfigurationTypeDef = ...,  # (1)
    documentAttributeConfigurations: Sequence[DocumentAttributeConfigurationTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See IndexCapacityConfigurationTypeDef
2. See Sequence[DocumentAttributeConfigurationTypeDef]

# update_index method usage example with argument unpacking

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

parent.update_index(**kwargs)

1. See UpdateIndexRequestTypeDef

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,
    displayName: str = ...,
    state: PluginStateType = ...,  # (1)
    serverUrl: str = ...,
    customPluginConfiguration: CustomPluginConfigurationTypeDef = ...,  # (2)
    authConfiguration: PluginAuthConfigurationUnionTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...

1. See PluginStateType
2. See CustomPluginConfigurationTypeDef
3. See PluginAuthConfigurationUnionTypeDef

# update_plugin method usage example with argument unpacking

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

parent.update_plugin(**kwargs)

1. See UpdatePluginRequestTypeDef

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: RetrieverConfigurationUnionTypeDef = ...,  # (1)
    displayName: str = ...,
    roleArn: str = ...,
) -> Dict[str, Any]:
    ...

1. See RetrieverConfigurationUnionTypeDef

# update_retriever method usage example with argument unpacking

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

parent.update_retriever(**kwargs)

1. See UpdateRetrieverRequestTypeDef

update_subscription

Updates the pricing tier for an Amazon Q Business subscription.

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

# update_subscription method definition

def update_subscription(
    self,
    *,
    applicationId: str,
    subscriptionId: str,
    type: SubscriptionTypeType,  # (1)
) -> UpdateSubscriptionResponseTypeDef:  # (2)
    ...

1. See SubscriptionTypeType
2. See UpdateSubscriptionResponseTypeDef

# update_subscription method usage example with argument unpacking

kwargs: UpdateSubscriptionRequestTypeDef = {  # (1)
    "applicationId": ...,
    "subscriptionId": ...,
    "type": ...,
}

parent.update_subscription(**kwargs)

1. See UpdateSubscriptionRequestTypeDef

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,
    userAliasesToUpdate: Sequence[UserAliasTypeDef] = ...,  # (1)
    userAliasesToDelete: Sequence[UserAliasTypeDef] = ...,  # (1)
) -> UpdateUserResponseTypeDef:  # (3)
    ...

1. See Sequence[UserAliasTypeDef]
2. See Sequence[UserAliasTypeDef]
3. See UpdateUserResponseTypeDef

# update_user method usage example with argument unpacking

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

parent.update_user(**kwargs)

1. See UpdateUserRequestTypeDef

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,
    roleArn: str = ...,
    authenticationConfiguration: WebExperienceAuthConfigurationTypeDef = ...,  # (1)
    title: str = ...,
    subtitle: str = ...,
    welcomeMessage: str = ...,
    samplePromptsControlMode: WebExperienceSamplePromptsControlModeType = ...,  # (2)
    identityProviderConfiguration: IdentityProviderConfigurationTypeDef = ...,  # (3)
    origins: Sequence[str] = ...,
    browserExtensionConfiguration: BrowserExtensionConfigurationUnionTypeDef = ...,  # (4)
    customizationConfiguration: CustomizationConfigurationTypeDef = ...,  # (5)
) -> Dict[str, Any]:
    ...

1. See WebExperienceAuthConfigurationTypeDef
2. See WebExperienceSamplePromptsControlModeType
3. See IdentityProviderConfigurationTypeDef
4. See BrowserExtensionConfigurationUnionTypeDef
5. See CustomizationConfigurationTypeDef

# update_web_experience method usage example with argument unpacking

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

parent.update_web_experience(**kwargs)

1. See UpdateWebExperienceRequestTypeDef

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_attachments") -> ListAttachmentsPaginator
• client.get_paginator("list_chat_response_configurations") -> ListChatResponseConfigurationsPaginator
• client.get_paginator("list_conversations") -> ListConversationsPaginator
• client.get_paginator("list_data_accessors") -> ListDataAccessorsPaginator
• 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_plugin_actions") -> ListPluginActionsPaginator
• client.get_paginator("list_plugin_type_actions") -> ListPluginTypeActionsPaginator
• client.get_paginator("list_plugin_type_metadata") -> ListPluginTypeMetadataPaginator
• client.get_paginator("list_plugins") -> ListPluginsPaginator
• client.get_paginator("list_retrievers") -> ListRetrieversPaginator
• client.get_paginator("list_subscriptions") -> ListSubscriptionsPaginator
• client.get_paginator("list_web_experiences") -> ListWebExperiencesPaginator
• client.get_paginator("search_relevant_content") -> SearchRelevantContentPaginator