QBusiness ********* Client ====== class QBusiness.Client A low-level client representing QBusiness This is the *Amazon Q Business* API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide. For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations. For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the *Amazon Q Business User Guide*. The following resources provide additional information about using the Amazon Q Business API: * Setting up for Amazon Q Business * Amazon Q Business CLI Reference * Amazon Web Services General Reference import boto3 client = boto3.client('qbusiness') These are the available methods: * associate_permission * batch_delete_document * batch_put_document * can_paginate * cancel_subscription * chat_sync * check_document_access * close * create_anonymous_web_experience_url * create_application * create_chat_response_configuration * create_data_accessor * create_data_source * create_index * create_plugin * create_retriever * create_subscription * create_user * create_web_experience * delete_application * delete_attachment * delete_chat_controls_configuration * delete_chat_response_configuration * delete_conversation * delete_data_accessor * delete_data_source * delete_group * delete_index * delete_plugin * delete_retriever * delete_user * delete_web_experience * disassociate_permission * get_application * get_chat_controls_configuration * get_chat_response_configuration * get_data_accessor * get_data_source * get_document_content * get_group * get_index * get_media * get_paginator * get_plugin * get_policy * get_retriever * get_user * get_waiter * get_web_experience * list_applications * list_attachments * list_chat_response_configurations * list_conversations * list_data_accessors * list_data_source_sync_jobs * list_data_sources * list_documents * list_groups * list_indices * list_messages * list_plugin_actions * list_plugin_type_actions * list_plugin_type_metadata * list_plugins * list_retrievers * list_subscriptions * list_tags_for_resource * list_web_experiences * put_feedback * put_group * search_relevant_content * start_data_source_sync_job * stop_data_source_sync_job * tag_resource * untag_resource * update_application * update_chat_controls_configuration * update_chat_response_configuration * update_data_accessor * update_data_source * update_index * update_plugin * update_retriever * update_subscription * update_user * update_web_experience Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * GetChatControlsConfiguration * ListApplications * ListAttachments * ListChatResponseConfigurations * ListConversations * ListDataAccessors * ListDataSourceSyncJobs * ListDataSources * ListDocuments * ListGroups * ListIndices * ListMessages * ListPluginActions * ListPluginTypeActions * ListPluginTypeMetadata * ListPlugins * ListRetrievers * ListSubscriptions * ListWebExperiences * SearchRelevantContent QBusiness / Paginator / ListSubscriptions ListSubscriptions ***************** class QBusiness.Paginator.ListSubscriptions paginator = client.get_paginator('list_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the subscription. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'subscriptions': [ { 'subscriptionId': 'string', 'subscriptionArn': 'string', 'principal': { 'user': 'string', 'group': 'string' }, 'currentSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' }, 'nextSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **subscriptions** *(list) --* An array of summary information on the subscriptions configured for an Amazon Q Business application. * *(dict) --* Information about an Amazon Q Business subscription. Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application. Amazon Q Business offers two subscription tiers: "Q_LITE" and "Q_BUSINESS". Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. * **subscriptionId** *(string) --* The identifier of the Amazon Q Business subscription to be updated. * **subscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated. * **principal** *(dict) --* The IAM Identity Center "UserId" or "GroupId" of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "user", "group". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **user** *(string) --* The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application. * **group** *(string) --* The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application. * **currentSubscription** *(dict) --* The type of your current Amazon Q Business subscription. * **type** *(string) --* The type of an Amazon Q Business subscription. * **nextSubscription** *(dict) --* The type of the Amazon Q Business subscription for the next month. * **type** *(string) --* The type of an Amazon Q Business subscription. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / SearchRelevantContent SearchRelevantContent ********************* class QBusiness.Paginator.SearchRelevantContent paginator = client.get_paginator('search_relevant_content') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.search_relevant_content()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', queryText='string', contentSource={ 'retriever': { 'retrieverId': 'string' } }, attributeFilter={ 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application to search. * **queryText** (*string*) -- **[REQUIRED]** The text to search for. * **contentSource** (*dict*) -- **[REQUIRED]** The source of content to search in. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "retriever". * **retriever** *(dict) --* The retriever to use as the content source. * **retrieverId** *(string) --* **[REQUIRED]** The unique identifier of the retriever to use as the content source. * **attributeFilter** (*dict*) -- Enables filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'relevantContent': [ { 'content': 'string', 'documentId': 'string', 'documentTitle': 'string', 'documentUri': 'string', 'documentAttributes': [ { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, ], 'scoreAttributes': { 'scoreConfidence': 'VERY_HIGH'|'HIGH'|'MEDIUM'|'LOW'|'NOT_AVAILABLE' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **relevantContent** *(list) --* The list of relevant content items found. * *(dict) --* Represents a piece of content that is relevant to a search query. * **content** *(string) --* The actual content of the relevant item. * **documentId** *(string) --* The unique identifier of the document containing the relevant content. * **documentTitle** *(string) --* The title of the document containing the relevant content. * **documentUri** *(string) --* The URI of the document containing the relevant content. * **documentAttributes** *(list) --* Additional attributes of the document containing the relevant content. * *(dict) --* A document attribute or metadata field. * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **scoreAttributes** *(dict) --* Attributes related to the relevance score of the content. * **scoreConfidence** *(string) --* The confidence level of the relevance score. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / GetChatControlsConfiguration GetChatControlsConfiguration **************************** class QBusiness.Paginator.GetChatControlsConfiguration paginator = client.get_paginator('get_chat_controls_configuration') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.get_chat_controls_configuration()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for which the chat controls are configured. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'responseScope': 'ENTERPRISE_CONTENT_ONLY'|'EXTENDED_KNOWLEDGE_ENABLED', 'orchestrationConfiguration': { 'control': 'ENABLED'|'DISABLED' }, 'blockedPhrases': { 'blockedPhrases': [ 'string', ], 'systemMessageOverride': 'string' }, 'topicConfigurations': [ { 'name': 'string', 'description': 'string', 'exampleChatMessages': [ 'string', ], 'rules': [ { 'includedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'excludedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'ruleType': 'CONTENT_BLOCKER_RULE'|'CONTENT_RETRIEVAL_RULE', 'ruleConfiguration': { 'contentBlockerRule': { 'systemMessageOverride': 'string' }, 'contentRetrievalRule': { 'eligibleDataSources': [ { 'indexId': 'string', 'dataSourceId': 'string' }, ] } } }, ] }, ], 'creatorModeConfiguration': { 'creatorModeControl': 'ENABLED'|'DISABLED' }, 'hallucinationReductionConfiguration': { 'hallucinationReductionControl': 'ENABLED'|'DISABLED' }, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **responseScope** *(string) --* The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat. * **orchestrationConfiguration** *(dict) --* The chat response orchestration settings for your application. Note: Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages. * **control** *(string) --* Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application. * **blockedPhrases** *(dict) --* The phrases blocked from chat by your chat control configuration. * **blockedPhrases** *(list) --* A list of phrases blocked from a Amazon Q Business web experience chat. * *(string) --* * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **topicConfigurations** *(list) --* The topic specific controls configured for a Amazon Q Business application. * *(dict) --* The topic specific controls configured for an Amazon Q Business application. * **name** *(string) --* A name for your topic control configuration. * **description** *(string) --* A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. * **exampleChatMessages** *(list) --* A list of example phrases that you expect the end user to use in relation to the topic. * *(string) --* * **rules** *(list) --* Rules defined for a topic configuration. * *(dict) --* Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time. * **includedUsersAndGroups** *(dict) --* Users and groups to be included in a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **excludedUsersAndGroups** *(dict) --* Users and groups to be excluded from a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **ruleType** *(string) --* The type of rule. * **ruleConfiguration** *(dict) --* The configuration information for a rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentBlockerRule", "contentRetrievalRule". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contentBlockerRule** *(dict) --* A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **contentRetrievalRule** *(dict) --* Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. * **eligibleDataSources** *(list) --* Specifies data sources in a Amazon Q Business application to use for content generation. * *(dict) --* The identifier of the data source Amazon Q Business will generate responses from. * **indexId** *(string) --* The identifier of the index the data source is attached to. * **dataSourceId** *(string) --* The identifier of the data source. * **creatorModeConfiguration** *(dict) --* The configuration details for "CREATOR_MODE". * **creatorModeControl** *(string) --* Information about whether creator mode is enabled or disabled for an Amazon Q Business application. * **hallucinationReductionConfiguration** *(dict) --* The hallucination reduction settings for your application. * **hallucinationReductionControl** *(string) --* Controls whether hallucination reduction has been enabled or disabled for your application. The default status is "DISABLED". * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListRetrievers ListRetrievers ************** class QBusiness.Paginator.ListRetrievers paginator = client.get_paginator('list_retrievers') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_retrievers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application using the retriever. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'retrievers': [ { 'applicationId': 'string', 'retrieverId': 'string', 'type': 'NATIVE_INDEX'|'KENDRA_INDEX', 'status': 'CREATING'|'ACTIVE'|'FAILED', 'displayName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **retrievers** *(list) --* An array of summary information for one or more retrievers. * *(dict) --* Summary information for the retriever used for your Amazon Q Business application. * **applicationId** *(string) --* The identifier of the Amazon Q Business application using the retriever. * **retrieverId** *(string) --* The identifier of the retriever used by your Amazon Q Business application. * **type** *(string) --* The type of your retriever. * **status** *(string) --* The status of your retriever. * **displayName** *(string) --* The name of your retriever. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListPlugins ListPlugins *********** class QBusiness.Paginator.ListPlugins paginator = client.get_paginator('list_plugins') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_plugins()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application the plugin is attached to. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'plugins': [ { 'pluginId': 'string', 'displayName': 'string', 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'serverUrl': 'string', 'state': 'ENABLED'|'DISABLED', 'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **plugins** *(list) --* Information about a configured plugin. * *(dict) --* Information about an Amazon Q Business plugin and its configuration. * **pluginId** *(string) --* The identifier of the plugin. * **displayName** *(string) --* The name of the plugin. * **type** *(string) --* The type of the plugin. * **serverUrl** *(string) --* The plugin server URL used for configuration. * **state** *(string) --* The current status of the plugin. * **buildStatus** *(string) --* The status of the plugin. * **createdAt** *(datetime) --* The timestamp for when the plugin was created. * **updatedAt** *(datetime) --* The timestamp for when the plugin was last updated. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListPluginTypeActions ListPluginTypeActions ********************* class QBusiness.Paginator.ListPluginTypeActions paginator = client.get_paginator('list_plugin_type_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_plugin_type_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( pluginType='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **pluginType** (*string*) -- **[REQUIRED]** The type of the plugin. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionIdentifier': 'string', 'displayName': 'string', 'instructionExample': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* An array of information on one or more plugins. * *(dict) --* Summary information for an Amazon Q Business plugin action. * **actionIdentifier** *(string) --* The identifier of an Amazon Q Business plugin action. * **displayName** *(string) --* The display name assigned by Amazon Q Business to a plugin action. You can't modify this value. * **instructionExample** *(string) --* An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example: * Create a Jira task * Create a chat assistant task to find the root cause of a specific incident * **description** *(string) --* The description of an Amazon Q Business plugin action. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListPluginActions ListPluginActions ***************** class QBusiness.Paginator.ListPluginActions paginator = client.get_paginator('list_plugin_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_plugin_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', pluginId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the plugin is attached to. * **pluginId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business plugin. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'actionIdentifier': 'string', 'displayName': 'string', 'instructionExample': 'string', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* An array of information on one or more plugin actions. * *(dict) --* Summary information for an Amazon Q Business plugin action. * **actionIdentifier** *(string) --* The identifier of an Amazon Q Business plugin action. * **displayName** *(string) --* The display name assigned by Amazon Q Business to a plugin action. You can't modify this value. * **instructionExample** *(string) --* An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example: * Create a Jira task * Create a chat assistant task to find the root cause of a specific incident * **description** *(string) --* The description of an Amazon Q Business plugin action. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListConversations ListConversations ***************** class QBusiness.Paginator.ListConversations paginator = client.get_paginator('list_conversations') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_conversations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', userId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **userId** (*string*) -- The identifier of the user involved in the Amazon Q Business web experience conversation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'conversations': [ { 'conversationId': 'string', 'title': 'string', 'startTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **conversations** *(list) --* An array of summary information on the configuration of one or more Amazon Q Business web experiences. * *(dict) --* A conversation in an Amazon Q Business application. * **conversationId** *(string) --* The identifier of the Amazon Q Business conversation. * **title** *(string) --* The title of the conversation. * **startTime** *(datetime) --* The start time of the conversation. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListChatResponseConfigurations ListChatResponseConfigurations ****************************** class QBusiness.Paginator.ListChatResponseConfigurations paginator = client.get_paginator('list_chat_response_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_chat_response_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application for which to list available chat response configurations. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'chatResponseConfigurations': [ { 'chatResponseConfigurationId': 'string', 'chatResponseConfigurationArn': 'string', 'displayName': 'string', 'responseConfigurationSummary': 'string', 'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **chatResponseConfigurations** *(list) --* A list of chat response configuration summaries, each containing key information about an available configuration in the specified application. * *(dict) --* Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards. * **chatResponseConfigurationId** *(string) --* A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service. * **chatResponseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts. * **displayName** *(string) --* A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization. * **responseConfigurationSummary** *(string) --* A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted. * **status** *(string) --* The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions. * **createdAt** *(datetime) --* The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources. * **updatedAt** *(datetime) --* The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListPluginTypeMetadata ListPluginTypeMetadata ********************** class QBusiness.Paginator.ListPluginTypeMetadata paginator = client.get_paginator('list_plugin_type_metadata') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_plugin_type_metadata()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'category': 'Customer relationship management (CRM)'|'Project management'|'Communication'|'Productivity'|'Ticketing and incident management', 'description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* An array of information on plugin metadata. * *(dict) --* Summary metadata information for a Amazon Q Business plugin. * **type** *(string) --* The type of the plugin. * **category** *(string) --* The category of the plugin type. * **description** *(string) --* The description assigned by Amazon Q Business to a plugin. You can't modify this value. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListDataSourceSyncJobs ListDataSourceSyncJobs ********************** class QBusiness.Paginator.ListDataSourceSyncJobs paginator = client.get_paginator('list_data_source_sync_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_data_source_sync_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( dataSourceId='string', applicationId='string', indexId='string', startTime=datetime(2015, 1, 1), endTime=datetime(2015, 1, 1), statusFilter='FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the data source. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with the Amazon Q Business data source connector. * **startTime** (*datetime*) -- The start time of the data source connector sync. * **endTime** (*datetime*) -- The end time of the data source connector sync. * **statusFilter** (*string*) -- Only returns synchronization jobs with the "Status" field equal to the specified status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'history': [ { 'executionId': 'string', 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'status': 'FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'dataSourceErrorCode': 'string', 'metrics': { 'documentsAdded': 'string', 'documentsModified': 'string', 'documentsDeleted': 'string', 'documentsFailed': 'string', 'documentsScanned': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **history** *(list) --* A history of synchronization jobs for the data source connector. * *(dict) --* Provides information about an Amazon Q Business data source connector synchronization job. * **executionId** *(string) --* The identifier of a data source synchronization job. * **startTime** *(datetime) --* The Unix time stamp when the data source synchronization job started. * **endTime** *(datetime) --* The Unix timestamp when the synchronization job completed. * **status** *(string) --* The status of the synchronization job. When the "Status" field is set to "SUCCEEDED", the synchronization job is done. If the status code is "FAILED", the "ErrorCode" and "ErrorMessage" fields give you the reason for the failure. * **error** *(dict) --* If the "Status" field is set to "FAILED", the "ErrorCode" field indicates the reason the synchronization failed. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **dataSourceErrorCode** *(string) --* If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error. * **metrics** *(dict) --* Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector. * **documentsAdded** *(string) --* The current count of documents added from the data source during the data source sync. * **documentsModified** *(string) --* The current count of documents modified in the data source during the data source sync. * **documentsDeleted** *(string) --* The current count of documents deleted from the data source during the data source sync. * **documentsFailed** *(string) --* The current count of documents that failed to sync from the data source during the data source sync. * **documentsScanned** *(string) --* The current count of documents crawled by the ongoing sync job in the data source. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListDataSources ListDataSources *************** class QBusiness.Paginator.ListDataSources paginator = client.get_paginator('list_data_sources') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_data_sources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', indexId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the data source connectors. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with one or more data source connectors. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'dataSources': [ { 'displayName': 'string', 'dataSourceId': 'string', 'type': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'PENDING_CREATION'|'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **dataSources** *(list) --* An array of summary information for one or more data source connector. * *(dict) --* A data source in an Amazon Q Business application. * **displayName** *(string) --* The name of the Amazon Q Business data source. * **dataSourceId** *(string) --* The identifier of the Amazon Q Business data source. * **type** *(string) --* The type of the Amazon Q Business data source. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business data source was created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business data source was last updated. * **status** *(string) --* The status of the Amazon Q Business data source. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListDocuments ListDocuments ************* class QBusiness.Paginator.ListDocuments paginator = client.get_paginator('list_documents') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_documents()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', indexId='string', dataSourceIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application id the documents are attached to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index the documents are attached to. * **dataSourceIds** (*list*) -- The identifier of the data sources the documents are attached to. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'documentDetailList': [ { 'documentId': 'string', 'status': 'RECEIVED'|'PROCESSING'|'INDEXED'|'UPDATED'|'FAILED'|'DELETING'|'DELETED'|'DOCUMENT_FAILED_TO_INDEX', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **documentDetailList** *(list) --* A list of document details. * *(dict) --* The details of a document within an Amazon Q Business index. * **documentId** *(string) --* The identifier of the document. * **status** *(string) --* The current status of the document. * **error** *(dict) --* An error message associated with the document. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **createdAt** *(datetime) --* The timestamp for when the document was created. * **updatedAt** *(datetime) --* The timestamp for when the document was last updated. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListIndices ListIndices *********** class QBusiness.Paginator.ListIndices paginator = client.get_paginator('list_indices') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_indices()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the index. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'indices': [ { 'displayName': 'string', 'indexId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **indices** *(list) --* An array of information on the items in one or more indexes. * *(dict) --* Summary information for your Amazon Q Business index. * **displayName** *(string) --* The name of the index. * **indexId** *(string) --* The identifier for the index. * **createdAt** *(datetime) --* The Unix timestamp when the index was created. * **updatedAt** *(datetime) --* The Unix timestamp when the index was last updated. * **status** *(string) --* The current status of the index. When the status is "ACTIVE", the index is ready. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListDataAccessors ListDataAccessors ***************** class QBusiness.Paginator.ListDataAccessors paginator = client.get_paginator('list_data_accessors') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_data_accessors()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'dataAccessors': [ { 'displayName': 'string', 'dataAccessorId': 'string', 'dataAccessorArn': 'string', 'idcApplicationArn': 'string', 'principal': 'string', 'authenticationDetail': { 'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE', 'authenticationConfiguration': { 'idcTrustedTokenIssuerConfiguration': { 'idcTrustedTokenIssuerArn': 'string' } }, 'externalIds': [ 'string', ] }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **dataAccessors** *(list) --* The list of data accessors. * *(dict) --* Provides summary information about a data accessor. * **displayName** *(string) --* The friendly name of the data accessor. * **dataAccessorId** *(string) --* The unique identifier of the data accessor. * **dataAccessorArn** *(string) --* The Amazon Resource Name (ARN) of the data accessor. * **idcApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the associated IAM Identity Center application. * **principal** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. * **authenticationDetail** *(dict) --* The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor. * **authenticationType** *(string) --* The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: * "AWS_IAM_IDC_TTI" - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. * "AWS_IAM_IDC_AUTH_CODE" - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. * **authenticationConfiguration** *(dict) --* The specific authentication configuration based on the authentication type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "idcTrustedTokenIssuerConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **idcTrustedTokenIssuerConfiguration** *(dict) --* Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is "AWS_IAM_IDC_TTI". * **idcTrustedTokenIssuerArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. * **externalIds** *(list) --* A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. * *(string) --* * **createdAt** *(datetime) --* The timestamp when the data accessor was created. * **updatedAt** *(datetime) --* The timestamp when the data accessor was last updated. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListAttachments ListAttachments *************** class QBusiness.Paginator.ListAttachments paginator = client.get_paginator('list_attachments') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_attachments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', conversationId='string', userId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier for the Amazon Q Business application. * **conversationId** (*string*) -- The unique identifier of the Amazon Q Business web experience conversation. * **userId** (*string*) -- The unique identifier of the user involved in the Amazon Q Business web experience conversation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'attachments': [ { 'attachmentId': 'string', 'conversationId': 'string', 'name': 'string', 'copyFrom': { 'conversation': { 'conversationId': 'string', 'attachmentId': 'string' } }, 'fileType': 'string', 'fileSize': 123, 'md5chksum': 'string', 'createdAt': datetime(2015, 1, 1), 'status': 'FAILED'|'SUCCESS', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **attachments** *(list) --* An array of information on one or more attachments. * *(dict) --* An attachment in an Amazon Q Business conversation. * **attachmentId** *(string) --* The identifier of the Amazon Q Business attachment. * **conversationId** *(string) --* The identifier of the Amazon Q Business conversation the attachment is associated with. * **name** *(string) --* Filename of the Amazon Q Business attachment. * **copyFrom** *(dict) --* A CopyFromSource containing a reference to the original source of the Amazon Q Business attachment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "conversation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **conversation** *(dict) --* A reference to an attachment in an existing conversation. * **conversationId** *(string) --* The unique identifier of the Amazon Q Business conversation. * **attachmentId** *(string) --* The unique identifier of the Amazon Q Business attachment. * **fileType** *(string) --* Filetype of the Amazon Q Business attachment. * **fileSize** *(integer) --* Size in bytes of the Amazon Q Business attachment. * **md5chksum** *(string) --* MD5 checksum of the Amazon Q Business attachment contents. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business attachment was created. * **status** *(string) --* AttachmentStatus of the Amazon Q Business attachment. * **error** *(dict) --* ErrorDetail providing information about a Amazon Q Business attachment error. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListApplications ListApplications **************** class QBusiness.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'applications': [ { 'displayName': 'string', 'applicationId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS', 'quickSightConfiguration': { 'clientNamespace': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **applications** *(list) --* An array of summary information on the configuration of one or more Amazon Q Business applications. * *(dict) --* Summary information for an Amazon Q Business application. * **displayName** *(string) --* The name of the Amazon Q Business application. * **applicationId** *(string) --* The identifier for the Amazon Q Business application. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **status** *(string) --* The status of the Amazon Q Business application. The application is ready to use when the status is "ACTIVE". * **identityType** *(string) --* The authentication type being used by a Amazon Q Business application. * **quickSightConfiguration** *(dict) --* The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. * **clientNamespace** *(string) --* The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListGroups ListGroups ********** class QBusiness.Paginator.ListGroups paginator = client.get_paginator('list_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', indexId='string', updatedEarlierThan=datetime(2015, 1, 1), dataSourceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for getting a list of groups mapped to users. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index for getting a list of groups mapped to users. * **updatedEarlierThan** (*datetime*) -- **[REQUIRED]** The timestamp identifier used for the latest "PUT" or "DELETE" action for mapping users to their groups. * **dataSourceId** (*string*) -- The identifier of the data source for getting a list of groups mapped to users. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'groupName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* Summary information for list of groups that are mapped to users. * *(dict) --* Summary information for groups. * **groupName** *(string) --* The name of the group the summary information is for. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListMessages ListMessages ************ class QBusiness.Paginator.ListMessages paginator = client.get_paginator('list_messages') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_messages()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( conversationId='string', applicationId='string', userId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **conversationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience conversation. * **applicationId** (*string*) -- **[REQUIRED]** The identifier for the Amazon Q Business application. * **userId** (*string*) -- The identifier of the user involved in the Amazon Q Business web experience conversation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'messages': [ { 'messageId': 'string', 'body': 'string', 'time': datetime(2015, 1, 1), 'type': 'USER'|'SYSTEM', 'attachments': [ { 'name': 'string', 'status': 'FAILED'|'SUCCESS', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'attachmentId': 'string', 'conversationId': 'string' }, ], 'sourceAttribution': [ { 'title': 'string', 'snippet': 'string', 'url': 'string', 'citationNumber': 123, 'updatedAt': datetime(2015, 1, 1), 'textMessageSegments': [ { 'beginOffset': 123, 'endOffset': 123, 'snippetExcerpt': { 'text': 'string' }, 'mediaId': 'string', 'mediaMimeType': 'string', 'sourceDetails': { 'imageSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string' }, 'audioSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'audioExtractionType': 'TRANSCRIPT'|'SUMMARY' }, 'videoSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'videoExtractionType': 'TRANSCRIPT'|'SUMMARY' } } }, ], 'documentId': 'string', 'indexId': 'string', 'datasourceId': 'string' }, ], 'actionReview': { 'pluginId': 'string', 'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'payload': { 'string': { 'displayName': 'string', 'displayOrder': 123, 'displayDescription': 'string', 'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN', 'value': {...}|[...]|123|123.4|'string'|True|None, 'allowedValues': [ { 'value': {...}|[...]|123|123.4|'string'|True|None, 'displayValue': {...}|[...]|123|123.4|'string'|True|None }, ], 'allowedFormat': 'string', 'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None, 'required': True|False } }, 'payloadFieldNameSeparator': 'string' }, 'actionExecution': { 'pluginId': 'string', 'payload': { 'string': { 'value': {...}|[...]|123|123.4|'string'|True|None } }, 'payloadFieldNameSeparator': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **messages** *(list) --* An array of information on one or more messages. * *(dict) --* A message in an Amazon Q Business web experience. * **messageId** *(string) --* The identifier of the Amazon Q Business web experience message. * **body** *(string) --* The content of the Amazon Q Business web experience message. * **time** *(datetime) --* The timestamp of the first Amazon Q Business web experience message. * **type** *(string) --* The type of Amazon Q Business message, whether "HUMAN" or "AI" generated. * **attachments** *(list) --* A file directly uploaded into an Amazon Q Business web experience chat. * *(dict) --* The details of a file uploaded during chat. * **name** *(string) --* The name of a file uploaded during chat. * **status** *(string) --* The status of a file uploaded during chat. * **error** *(dict) --* An error associated with a file uploaded during chat. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **attachmentId** *(string) --* The unique identifier of the Amazon Q Business attachment. * **conversationId** *(string) --* The unique identifier of the Amazon Q Business conversation. * **sourceAttribution** *(list) --* The source documents used to generate Amazon Q Business web experience message. * *(dict) --* The documents used to generate an Amazon Q Business web experience response. * **title** *(string) --* The title of the document which is the source for the Amazon Q Business generated response. * **snippet** *(string) --* The content extract from the document on which the generated response is based. * **url** *(string) --* The URL of the document which is the source for the Amazon Q Business generated response. * **citationNumber** *(integer) --* The number attached to a citation in an Amazon Q Business generated response. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **textMessageSegments** *(list) --* A text extract from a source document that is used for source attribution. * *(dict) --* Provides information about a text extract in a chat response that can be attributed to a source document. * **beginOffset** *(integer) --* The zero-based location in the response string where the source attribution starts. * **endOffset** *(integer) --* The zero-based location in the response string where the source attribution ends. * **snippetExcerpt** *(dict) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response. * **text** *(string) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response. * **mediaId** *(string) --* The identifier of the media object associated with the text segment in the source attribution. * **mediaMimeType** *(string) --* The MIME type (image/png) of the media object associated with the text segment in the source attribution. * **sourceDetails** *(dict) --* Source information for a segment of extracted text, including its media type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "imageSourceDetails", "audioSourceDetails", "videoSourceDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **imageSourceDetails** *(dict) --* Details specific to image content within the source. * **mediaId** *(string) --* Unique identifier for the image file. * **mediaMimeType** *(string) --* The MIME type of the image file. * **audioSourceDetails** *(dict) --* Details specific to audio content within the source. * **mediaId** *(string) --* Unique identifier for the audio media file. * **mediaMimeType** *(string) --* The MIME type of the audio file (e.g., audio/mp3, audio/wav). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant audio segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant audio segment. * **audioExtractionType** *(string) --* The type of audio extraction performed on the content. * **videoSourceDetails** *(dict) --* Details specific to video content within the source. * **mediaId** *(string) --* Unique identifier for the video media file. * **mediaMimeType** *(string) --* The MIME type of the video file (e.g., video/mp4, video/avi). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant video segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant video segment. * **videoExtractionType** *(string) --* The type of video extraction performed on the content. * **documentId** *(string) --* The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the "GetDocumentContent" API to retrieve the actual document content for user verification. * **indexId** *(string) --* The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored. * **datasourceId** *(string) --* The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid". * **actionReview** *(dict) --* An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business. * **pluginId** *(string) --* The identifier of the plugin associated with the action review. * **pluginType** *(string) --* The type of plugin. * **payload** *(dict) --* Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action review payload. * **displayName** *(string) --* The name of the field. * **displayOrder** *(integer) --* The display order of fields in a payload. * **displayDescription** *(string) --* The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field. * **type** *(string) --* The type of field. * **value** (*document*) -- The field value. * **allowedValues** *(list) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(dict) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * **value** (*document*) -- The field value. * **displayValue** (*document*) -- The name of the field. * **allowedFormat** *(string) --* The expected data format for the action review input field value. For example, in PTO request, "from" and "to" would be of "datetime" allowed format. * **arrayItemJsonSchema** (*document*) -- Use to create a custom form with array fields (fields with nested objects inside an array). * **required** *(boolean) --* Information about whether the field is required. * **payloadFieldNameSeparator** *(string) --* A string used to retain information about the hierarchical contexts within an action review payload. * **actionExecution** *(dict) --* Performs an Amazon Q Business plugin action during a non-streaming chat conversation. * **pluginId** *(string) --* The identifier of the plugin the action is attached to. * **payload** *(dict) --* A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action execution payload. * **value** (*document*) -- The content of a user input field in an plugin action execution payload. * **payloadFieldNameSeparator** *(string) --* A string used to retain information about the hierarchical contexts within an action execution event payload. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Paginator / ListWebExperiences ListWebExperiences ****************** class QBusiness.Paginator.ListWebExperiences paginator = client.get_paginator('list_web_experiences') paginate(**kwargs) Creates an iterator that will paginate through responses from "QBusiness.Client.list_web_experiences()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the listed web experiences. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'webExperiences': [ { 'webExperienceId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'defaultEndpoint': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **webExperiences** *(list) --* An array of summary information for one or more Amazon Q Business experiences. * *(dict) --* Provides information for an Amazon Q Business web experience. * **webExperienceId** *(string) --* The identifier of your Amazon Q Business web experience. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **updatedAt** *(datetime) --* The Unix timestamp when your Amazon Q Business web experience was updated. * **defaultEndpoint** *(string) --* The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services. * **status** *(string) --* The status of your Amazon Q Business web experience. * **NextToken** *(string) --* A token to resume pagination. QBusiness / Client / update_retriever update_retriever **************** QBusiness.Client.update_retriever(**kwargs) Updates the retriever used for your Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.update_retriever( applicationId='string', retrieverId='string', configuration={ 'nativeIndexConfiguration': { 'indexId': 'string', 'version': 123, 'boostingOverride': { 'string': { 'numberConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES' }, 'stringConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'attributeValueBoosting': { 'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE' } }, 'dateConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingDurationInSeconds': 123 }, 'stringListConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO' } } } }, 'kendraIndexConfiguration': { 'indexId': 'string' } }, displayName='string', roleArn='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of your Amazon Q Business application. * **retrieverId** (*string*) -- **[REQUIRED]** The identifier of your retriever. * **configuration** (*dict*) -- Provides information on how the retriever used for your Amazon Q Business application is configured. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "nativeIndexConfiguration", "kendraIndexConfiguration". * **nativeIndexConfiguration** *(dict) --* Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* **[REQUIRED]** The identifier for the Amazon Q Business index. * **version** *(integer) --* A read-only field that specifies the version of the "NativeIndexConfiguration". Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of "NativeIndexConfiguration", focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1: * Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting * Version 2 supports a single String field with an ordered list of up to 5 values * Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels * Version 2 allows specifying prioritization between Date and String fields * Version 2 maintains backward compatibility with existing configurations * **boostingOverride** *(dict) --* Overrides the default boosts applied by Amazon Q Business to supported document attribute data types. * *(string) --* * *(dict) --* Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes. In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results. Note: For "STRING" and "STRING_LIST" type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "numberConfiguration", "stringConfiguration", "dateConfiguration", "stringListConfiguration". * **numberConfiguration** *(dict) --* Provides information on boosting "NUMBER" type document attributes. "NUMBER" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "NUMBER" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **boostingType** *(string) --* Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important). * **stringConfiguration** *(dict) --* Provides information on boosting "STRING" type document attributes. Version 2 assigns priority tiers to "STRING" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **attributeValueBoosting** *(dict) --* Specifies specific values of a "STRING" type document attribute being boosted. When using "NativeIndexConfiguration" version 2, you can specify up to five values in order of priority. * *(string) --* * *(string) --* * **dateConfiguration** *(dict) --* Provides information on boosting "DATE" type document attributes. Version 2 assigns priority tiers to "DATE" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **boostingDurationInSeconds** *(integer) --* Specifies the duration, in seconds, of a boost applies to a "DATE" type document attribute. * **stringListConfiguration** *(dict) --* Provides information on boosting "STRING_LIST" type document attributes. "STRING_LIST" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "STRING_LIST" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **kendraIndexConfiguration** *(dict) --* Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* **[REQUIRED]** The identifier of the Amazon Kendra index. * **displayName** (*string*) -- The name of your retriever. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_applications list_applications ***************** QBusiness.Client.list_applications(**kwargs) Lists Amazon Q Business applications. Note: Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. See also: AWS API Documentation **Request Syntax** response = client.list_applications( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications. * **maxResults** (*integer*) -- The maximum number of Amazon Q Business applications to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'applications': [ { 'displayName': 'string', 'applicationId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS', 'quickSightConfiguration': { 'clientNamespace': 'string' } }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications. * **applications** *(list) --* An array of summary information on the configuration of one or more Amazon Q Business applications. * *(dict) --* Summary information for an Amazon Q Business application. * **displayName** *(string) --* The name of the Amazon Q Business application. * **applicationId** *(string) --* The identifier for the Amazon Q Business application. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **status** *(string) --* The status of the Amazon Q Business application. The application is ready to use when the status is "ACTIVE". * **identityType** *(string) --* The authentication type being used by a Amazon Q Business application. * **quickSightConfiguration** *(dict) --* The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. * **clientNamespace** *(string) --* The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_plugin create_plugin ************* QBusiness.Client.create_plugin(**kwargs) Creates an Amazon Q Business plugin. See also: AWS API Documentation **Request Syntax** response = client.create_plugin( applicationId='string', displayName='string', type='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', authConfiguration={ 'basicAuthConfiguration': { 'secretArn': 'string', 'roleArn': 'string' }, 'oAuth2ClientCredentialConfiguration': { 'secretArn': 'string', 'roleArn': 'string', 'authorizationUrl': 'string', 'tokenUrl': 'string' }, 'noAuthConfiguration': {} , 'idcAuthConfiguration': { 'idcApplicationArn': 'string', 'roleArn': 'string' } }, serverUrl='string', customPluginConfiguration={ 'description': 'string', 'apiSchemaType': 'OPEN_API_V3', 'apiSchema': { 'payload': 'string', 's3': { 'bucket': 'string', 'key': 'string' } } }, tags=[ { 'key': 'string', 'value': 'string' }, ], clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application that will contain the plugin. * **displayName** (*string*) -- **[REQUIRED]** A the name for your plugin. * **type** (*string*) -- **[REQUIRED]** The type of plugin you want to create. * **authConfiguration** (*dict*) -- **[REQUIRED]** Authentication configuration information for an Amazon Q Business plugin. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "basicAuthConfiguration", "oAuth2ClientCredentialConfiguration", "noAuthConfiguration", "idcAuthConfiguration". * **basicAuthConfiguration** *(dict) --* Information about the basic authentication credentials used to configure a plugin. * **secretArn** *(string) --* **[REQUIRED]** The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration.. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. * **oAuth2ClientCredentialConfiguration** *(dict) --* Information about the OAuth 2.0 authentication credential/token used to configure a plugin. * **secretArn** *(string) --* **[REQUIRED]** The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret. * **authorizationUrl** *(string) --* The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server. * **tokenUrl** *(string) --* The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token. * **noAuthConfiguration** *(dict) --* Information about invoking a custom plugin without any authentication. * **idcAuthConfiguration** *(dict) --* Information about the IAM Identity Center Application used to configure authentication for a plugin. * **idcApplicationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication. * **roleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf. * **serverUrl** (*string*) -- The source URL used for plugin configuration. * **customPluginConfiguration** (*dict*) -- Contains configuration for a custom plugin. * **description** *(string) --* **[REQUIRED]** A description for your custom plugin configuration. * **apiSchemaType** *(string) --* **[REQUIRED]** The type of OpenAPI schema to use. * **apiSchema** *(dict) --* Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML- formatted payload defining the schema. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "payload", "s3". * **payload** *(string) --* The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. * **s3** *(dict) --* Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format. * **bucket** *(string) --* **[REQUIRED]** The name of the S3 bucket that contains the file. * **key** *(string) --* **[REQUIRED]** The name of the file. * **tags** (*list*) -- A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. * **clientToken** (*string*) -- A token that you provide to identify the request to create your Amazon Q Business plugin. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'pluginId': 'string', 'pluginArn': 'string', 'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED' } **Response Structure** * *(dict) --* * **pluginId** *(string) --* The identifier of the plugin created. * **pluginArn** *(string) --* The Amazon Resource Name (ARN) of a plugin. * **buildStatus** *(string) --* The current status of a plugin. A plugin is modified asynchronously. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / get_chat_controls_configuration get_chat_controls_configuration ******************************* QBusiness.Client.get_chat_controls_configuration(**kwargs) Gets information about chat controls configured for an existing Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.get_chat_controls_configuration( applicationId='string', maxResults=123, nextToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for which the chat controls are configured. * **maxResults** (*integer*) -- The maximum number of configured chat controls to return. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured. Return type: dict Returns: **Response Syntax** { 'responseScope': 'ENTERPRISE_CONTENT_ONLY'|'EXTENDED_KNOWLEDGE_ENABLED', 'orchestrationConfiguration': { 'control': 'ENABLED'|'DISABLED' }, 'blockedPhrases': { 'blockedPhrases': [ 'string', ], 'systemMessageOverride': 'string' }, 'topicConfigurations': [ { 'name': 'string', 'description': 'string', 'exampleChatMessages': [ 'string', ], 'rules': [ { 'includedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'excludedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'ruleType': 'CONTENT_BLOCKER_RULE'|'CONTENT_RETRIEVAL_RULE', 'ruleConfiguration': { 'contentBlockerRule': { 'systemMessageOverride': 'string' }, 'contentRetrievalRule': { 'eligibleDataSources': [ { 'indexId': 'string', 'dataSourceId': 'string' }, ] } } }, ] }, ], 'creatorModeConfiguration': { 'creatorModeControl': 'ENABLED'|'DISABLED' }, 'nextToken': 'string', 'hallucinationReductionConfiguration': { 'hallucinationReductionControl': 'ENABLED'|'DISABLED' } } **Response Structure** * *(dict) --* * **responseScope** *(string) --* The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat. * **orchestrationConfiguration** *(dict) --* The chat response orchestration settings for your application. Note: Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages. * **control** *(string) --* Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application. * **blockedPhrases** *(dict) --* The phrases blocked from chat by your chat control configuration. * **blockedPhrases** *(list) --* A list of phrases blocked from a Amazon Q Business web experience chat. * *(string) --* * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **topicConfigurations** *(list) --* The topic specific controls configured for a Amazon Q Business application. * *(dict) --* The topic specific controls configured for an Amazon Q Business application. * **name** *(string) --* A name for your topic control configuration. * **description** *(string) --* A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. * **exampleChatMessages** *(list) --* A list of example phrases that you expect the end user to use in relation to the topic. * *(string) --* * **rules** *(list) --* Rules defined for a topic configuration. * *(dict) --* Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time. * **includedUsersAndGroups** *(dict) --* Users and groups to be included in a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **excludedUsersAndGroups** *(dict) --* Users and groups to be excluded from a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **ruleType** *(string) --* The type of rule. * **ruleConfiguration** *(dict) --* The configuration information for a rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentBlockerRule", "contentRetrievalRule". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **contentBlockerRule** *(dict) --* A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **contentRetrievalRule** *(dict) --* Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. * **eligibleDataSources** *(list) --* Specifies data sources in a Amazon Q Business application to use for content generation. * *(dict) --* The identifier of the data source Amazon Q Business will generate responses from. * **indexId** *(string) --* The identifier of the index the data source is attached to. * **dataSourceId** *(string) --* The identifier of the data source. * **creatorModeConfiguration** *(dict) --* The configuration details for "CREATOR_MODE". * **creatorModeControl** *(string) --* Information about whether creator mode is enabled or disabled for an Amazon Q Business application. * **nextToken** *(string) --* If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured. * **hallucinationReductionConfiguration** *(dict) --* The hallucination reduction settings for your application. * **hallucinationReductionControl** *(string) --* Controls whether hallucination reduction has been enabled or disabled for your application. The default status is "DISABLED". **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_paginator get_paginator ************* QBusiness.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. QBusiness / Client / put_feedback put_feedback ************ QBusiness.Client.put_feedback(**kwargs) Enables your end user to provide feedback on their Amazon Q Business generated chat responses. See also: AWS API Documentation **Request Syntax** response = client.put_feedback( applicationId='string', userId='string', conversationId='string', messageId='string', messageCopiedAt=datetime(2015, 1, 1), messageUsefulness={ 'usefulness': 'USEFUL'|'NOT_USEFUL', 'reason': 'NOT_FACTUALLY_CORRECT'|'HARMFUL_OR_UNSAFE'|'INCORRECT_OR_MISSING_SOURCES'|'NOT_HELPFUL'|'FACTUALLY_CORRECT'|'COMPLETE'|'RELEVANT_SOURCES'|'HELPFUL'|'NOT_BASED_ON_DOCUMENTS'|'NOT_COMPLETE'|'NOT_CONCISE'|'OTHER', 'comment': 'string', 'submittedAt': datetime(2015, 1, 1) } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application associated with the feedback. * **userId** (*string*) -- The identifier of the user giving the feedback. * **conversationId** (*string*) -- **[REQUIRED]** The identifier of the conversation the feedback is attached to. * **messageId** (*string*) -- **[REQUIRED]** The identifier of the chat message that the feedback was given for. * **messageCopiedAt** (*datetime*) -- The timestamp for when the feedback was recorded. * **messageUsefulness** (*dict*) -- The feedback usefulness value given by the user to the chat message. * **usefulness** *(string) --* **[REQUIRED]** The usefulness value assigned by an end user to a message. * **reason** *(string) --* The reason for a usefulness rating. * **comment** *(string) --* A comment given by an end user on the usefulness of an AI- generated chat message. * **submittedAt** *(datetime) --* **[REQUIRED]** The timestamp for when the feedback was submitted. Returns: None **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_plugin delete_plugin ************* QBusiness.Client.delete_plugin(**kwargs) Deletes an Amazon Q Business plugin. See also: AWS API Documentation **Request Syntax** response = client.delete_plugin( applicationId='string', pluginId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier the application attached to the Amazon Q Business plugin. * **pluginId** (*string*) -- **[REQUIRED]** The identifier of the plugin being deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / search_relevant_content search_relevant_content *********************** QBusiness.Client.search_relevant_content(**kwargs) Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance. See also: AWS API Documentation **Request Syntax** response = client.search_relevant_content( applicationId='string', queryText='string', contentSource={ 'retriever': { 'retrieverId': 'string' } }, attributeFilter={ 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } }, maxResults=123, nextToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application to search. * **queryText** (*string*) -- **[REQUIRED]** The text to search for. * **contentSource** (*dict*) -- **[REQUIRED]** The source of content to search in. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "retriever". * **retriever** *(dict) --* The retriever to use as the content source. * **retrieverId** *(string) --* **[REQUIRED]** The unique identifier of the retriever to use as the content source. * **attributeFilter** (*dict*) -- Enables filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **maxResults** (*integer*) -- The maximum number of results to return. * **nextToken** (*string*) -- The token for the next set of results. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'relevantContent': [ { 'content': 'string', 'documentId': 'string', 'documentTitle': 'string', 'documentUri': 'string', 'documentAttributes': [ { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, ], 'scoreAttributes': { 'scoreConfidence': 'VERY_HIGH'|'HIGH'|'MEDIUM'|'LOW'|'NOT_AVAILABLE' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **relevantContent** *(list) --* The list of relevant content items found. * *(dict) --* Represents a piece of content that is relevant to a search query. * **content** *(string) --* The actual content of the relevant item. * **documentId** *(string) --* The unique identifier of the document containing the relevant content. * **documentTitle** *(string) --* The title of the document containing the relevant content. * **documentUri** *(string) --* The URI of the document containing the relevant content. * **documentAttributes** *(list) --* Additional attributes of the document containing the relevant content. * *(dict) --* A document attribute or metadata field. * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **scoreAttributes** *(dict) --* Attributes related to the relevance score of the content. * **scoreConfidence** *(string) --* The confidence level of the relevance score. * **nextToken** *(string) --* The token to use to retrieve the next set of results, if there are any. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_user get_user ******** QBusiness.Client.get_user(**kwargs) Describes the universally unique identifier (UUID) associated with a local user in a data source. See also: AWS API Documentation **Request Syntax** response = client.get_user( applicationId='string', userId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application connected to the user. * **userId** (*string*) -- **[REQUIRED]** The user email address attached to the user. Return type: dict Returns: **Response Syntax** { 'userAliases': [ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ] } **Response Structure** * *(dict) --* * **userAliases** *(list) --* A list of user aliases attached to a user. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* The identifier of the user id associated with the user aliases. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_chat_response_configuration delete_chat_response_configuration ********************************** QBusiness.Client.delete_chat_response_configuration(**kwargs) Deletes a specified chat response configuration from an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.delete_chat_response_configuration( applicationId='string', chatResponseConfigurationId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of theAmazon Q Business application from which to delete the chat response configuration. * **chatResponseConfigurationId** (*string*) -- **[REQUIRED]** The unique identifier of the chat response configuration to delete from the specified application. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_data_source get_data_source *************** QBusiness.Client.get_data_source(**kwargs) Gets information about an existing Amazon Q Business data source connector. See also: AWS API Documentation **Request Syntax** response = client.get_data_source( applicationId='string', indexId='string', dataSourceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **indexId** (*string*) -- **[REQUIRED]** The identfier of the index used with the data source connector. * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'indexId': 'string', 'dataSourceId': 'string', 'dataSourceArn': 'string', 'displayName': 'string', 'type': 'string', 'configuration': {...}|[...]|123|123.4|'string'|True|None, 'vpcConfiguration': { 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'description': 'string', 'status': 'PENDING_CREATION'|'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'syncSchedule': 'string', 'roleArn': 'string', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'documentEnrichmentConfiguration': { 'inlineConfigurations': [ { 'condition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'target': { 'key': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) }, 'attributeValueOperator': 'DELETE' }, 'documentContentOperator': 'DELETE' }, ], 'preExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' }, 'postExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' } }, 'mediaExtractionConfiguration': { 'imageExtractionConfiguration': { 'imageExtractionStatus': 'ENABLED'|'DISABLED' }, 'audioExtractionConfiguration': { 'audioExtractionStatus': 'ENABLED'|'DISABLED' }, 'videoExtractionConfiguration': { 'videoExtractionStatus': 'ENABLED'|'DISABLED' } } } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the Amazon Q Business application. * **indexId** *(string) --* The identifier of the index linked to the data source connector. * **dataSourceId** *(string) --* The identifier of the data source connector. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the data source. * **displayName** *(string) --* The name for the data source connector. * **type** *(string) --* The type of the data source connector. For example, "S3". * **configuration** (*document*) -- The details of how the data source connector is configured. * **vpcConfiguration** *(dict) --* Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. * **subnetIds** *(list) --* A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device. * *(string) --* * **securityGroupIds** *(list) --* A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source. * *(string) --* * **createdAt** *(datetime) --* The Unix timestamp when the data source connector was created. * **updatedAt** *(datetime) --* The Unix timestamp when the data source connector was last updated. * **description** *(string) --* The description for the data source connector. * **status** *(string) --* The current status of the data source connector. When the "Status" field value is "FAILED", the "ErrorMessage" field contains a description of the error that caused the data source connector to fail. * **syncSchedule** *(string) --* The schedule for Amazon Q Business to update the index. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources. * **error** *(dict) --* When the "Status" field value is "FAILED", the "ErrorMessage" field contains a description of the error that caused the data source connector to fail. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **documentEnrichmentConfiguration** *(dict) --* Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment. * **inlineConfigurations** *(list) --* Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business. * *(dict) --* Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration. For more information, see Custom document enrichment. * **condition** *(dict) --* The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using "DocumentAttributeTarget". Amazon Q Business then will map your newly created metadata field to your index field. * **key** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **target** *(dict) --* The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to "TRUE". This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition. * **key** *(string) --* The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **attributeValueOperator** *(string) --* "TRUE" to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to "TRUE". * **documentContentOperator** *(string) --* "TRUE" to delete content if the condition used for the target attribute is met. * **preExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date- time. * **key** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **postExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date- time. * **key** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **mediaExtractionConfiguration** *(dict) --* The configuration for extracting information from media in documents for the data source. * **imageExtractionConfiguration** *(dict) --* The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals. * **imageExtractionStatus** *(string) --* Specify whether to extract semantic meaning from images and visuals from documents. * **audioExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing audio content from media files. * **audioExtractionStatus** *(string) --* The status of audio extraction (ENABLED or DISABLED) for processing audio content from files. * **videoExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing video content from media files. * **videoExtractionStatus** *(string) --* The status of video extraction (ENABLED or DISABLED) for processing video content from files. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_data_accessor get_data_accessor ***************** QBusiness.Client.get_data_accessor(**kwargs) Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated. See also: AWS API Documentation **Request Syntax** response = client.get_data_accessor( applicationId='string', dataAccessorId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **dataAccessorId** (*string*) -- **[REQUIRED]** The unique identifier of the data accessor to retrieve. Return type: dict Returns: **Response Syntax** { 'displayName': 'string', 'dataAccessorId': 'string', 'dataAccessorArn': 'string', 'applicationId': 'string', 'idcApplicationArn': 'string', 'principal': 'string', 'actionConfigurations': [ { 'action': 'string', 'filterConfiguration': { 'documentAttributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } } }, ], 'authenticationDetail': { 'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE', 'authenticationConfiguration': { 'idcTrustedTokenIssuerConfiguration': { 'idcTrustedTokenIssuerArn': 'string' } }, 'externalIds': [ 'string', ] }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **displayName** *(string) --* The friendly name of the data accessor. * **dataAccessorId** *(string) --* The unique identifier of the data accessor. * **dataAccessorArn** *(string) --* The Amazon Resource Name (ARN) of the data accessor. * **applicationId** *(string) --* The unique identifier of the Amazon Q Business application associated with this data accessor. * **idcApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor. * **principal** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. * **actionConfigurations** *(list) --* The list of action configurations specifying the allowed actions and any associated filters. * *(dict) --* Specifies an allowed action and its associated filter configuration. * **action** *(string) --* The Amazon Q Business action that is allowed. * **filterConfiguration** *(dict) --* The filter configuration for the action, if any. * **documentAttributeFilter** *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **authenticationDetail** *(dict) --* The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor. * **authenticationType** *(string) --* The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: * "AWS_IAM_IDC_TTI" - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. * "AWS_IAM_IDC_AUTH_CODE" - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. * **authenticationConfiguration** *(dict) --* The specific authentication configuration based on the authentication type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "idcTrustedTokenIssuerConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **idcTrustedTokenIssuerConfiguration** *(dict) --* Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is "AWS_IAM_IDC_TTI". * **idcTrustedTokenIssuerArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. * **externalIds** *(list) --* A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. * *(string) --* * **createdAt** *(datetime) --* The timestamp when the data accessor was created. * **updatedAt** *(datetime) --* The timestamp when the data accessor was last updated. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_attachment delete_attachment ***************** QBusiness.Client.delete_attachment(**kwargs) Deletes an attachment associated with a specific Amazon Q Business conversation. See also: AWS API Documentation **Request Syntax** response = client.delete_attachment( applicationId='string', conversationId='string', attachmentId='string', userId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier for the Amazon Q Business application environment. * **conversationId** (*string*) -- **[REQUIRED]** The unique identifier of the conversation. * **attachmentId** (*string*) -- **[REQUIRED]** The unique identifier for the attachment. * **userId** (*string*) -- The unique identifier of the user involved in the conversation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_retrievers list_retrievers *************** QBusiness.Client.list_retrievers(**kwargs) Lists the retriever used by an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.list_retrievers( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application using the retriever. * **nextToken** (*string*) -- If the number of retrievers returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers. * **maxResults** (*integer*) -- The maximum number of retrievers returned. Return type: dict Returns: **Response Syntax** { 'retrievers': [ { 'applicationId': 'string', 'retrieverId': 'string', 'type': 'NATIVE_INDEX'|'KENDRA_INDEX', 'status': 'CREATING'|'ACTIVE'|'FAILED', 'displayName': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **retrievers** *(list) --* An array of summary information for one or more retrievers. * *(dict) --* Summary information for the retriever used for your Amazon Q Business application. * **applicationId** *(string) --* The identifier of the Amazon Q Business application using the retriever. * **retrieverId** *(string) --* The identifier of the retriever used by your Amazon Q Business application. * **type** *(string) --* The type of your retriever. * **status** *(string) --* The status of your retriever. * **displayName** *(string) --* The name of your retriever. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / can_paginate can_paginate ************ QBusiness.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. QBusiness / Client / batch_put_document batch_put_document ****************** QBusiness.Client.batch_put_document(**kwargs) Adds one or more documents to an Amazon Q Business index. You use this API to: * ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. * add custom attributes to documents in an Amazon Q Business index. * attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. See also: AWS API Documentation **Request Syntax** response = client.batch_put_document( applicationId='string', indexId='string', documents=[ { 'id': 'string', 'attributes': [ { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, ], 'content': { 'blob': b'bytes', 's3': { 'bucket': 'string', 'key': 'string' } }, 'contentType': 'PDF'|'HTML'|'MS_WORD'|'PLAIN_TEXT'|'PPT'|'RTF'|'XML'|'XSLT'|'MS_EXCEL'|'CSV'|'JSON'|'MD', 'title': 'string', 'accessConfiguration': { 'accessControls': [ { 'principals': [ { 'user': { 'id': 'string', 'access': 'ALLOW'|'DENY', 'membershipType': 'INDEX'|'DATASOURCE' }, 'group': { 'name': 'string', 'access': 'ALLOW'|'DENY', 'membershipType': 'INDEX'|'DATASOURCE' } }, ], 'memberRelation': 'AND'|'OR' }, ], 'memberRelation': 'AND'|'OR' }, 'documentEnrichmentConfiguration': { 'inlineConfigurations': [ { 'condition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'target': { 'key': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) }, 'attributeValueOperator': 'DELETE' }, 'documentContentOperator': 'DELETE' }, ], 'preExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' }, 'postExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' } }, 'mediaExtractionConfiguration': { 'imageExtractionConfiguration': { 'imageExtractionStatus': 'ENABLED'|'DISABLED' }, 'audioExtractionConfiguration': { 'audioExtractionStatus': 'ENABLED'|'DISABLED' }, 'videoExtractionConfiguration': { 'videoExtractionStatus': 'ENABLED'|'DISABLED' } } }, ], roleArn='string', dataSourceSyncId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business index to add the documents to. * **documents** (*list*) -- **[REQUIRED]** One or more documents to add to the index. * *(dict) --* A document in an Amazon Q Business application. * **id** *(string) --* **[REQUIRED]** The identifier of the document. * **attributes** *(list) --* Custom attributes to apply to the document for refining Amazon Q Business web experience responses. * *(dict) --* A document attribute or metadata field. * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **content** *(dict) --* The contents of the document. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "blob", "s3". * **blob** *(bytes) --* The contents of the document. Documents passed to the "blob" parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending. * **s3** *(dict) --* The path to the document in an Amazon S3 bucket. * **bucket** *(string) --* **[REQUIRED]** The name of the S3 bucket that contains the file. * **key** *(string) --* **[REQUIRED]** The name of the file. * **contentType** *(string) --* The file type of the document in the Blob field. If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the "HTML" start and closing tags ( "content") around the content. * **title** *(string) --* The title of the document. * **accessConfiguration** *(dict) --* Configuration information for access permission to a document. * **accessControls** *(list) --* **[REQUIRED]** A list of "AccessControlList" objects. * *(dict) --* A list of principals. Each principal can be either a "USER" or a "GROUP" and can be designated document access permissions of either "ALLOW" or "DENY". * **principals** *(list) --* **[REQUIRED]** Contains a list of principals, where a principal can be either a "USER" or a "GROUP". Each principal can be have the following type of document access: "ALLOW" or "DENY". * *(dict) --* Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "user", "group". * **user** *(dict) --* The user associated with the principal. * **id** *(string) --* The identifier of the user. * **access** *(string) --* **[REQUIRED]** Provides information about whether to allow or deny access to the principal. * **membershipType** *(string) --* The type of group. * **group** *(dict) --* The group associated with the principal. * **name** *(string) --* The name of the group. * **access** *(string) --* **[REQUIRED]** Provides information about whether to allow or deny access to the principal. * **membershipType** *(string) --* The type of group. * **memberRelation** *(string) --* Describes the member relation within a principal list. * **memberRelation** *(string) --* Describes the member relation within the "AccessControlList" object. * **documentEnrichmentConfiguration** *(dict) --* The configuration information for altering document metadata and content during the document ingestion process. * **inlineConfigurations** *(list) --* Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business. * *(dict) --* Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration. For more information, see Custom document enrichment. * **condition** *(dict) --* The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using "DocumentAttributeTarget". Amazon Q Business then will map your newly created metadata field to your index field. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **target** *(dict) --* The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to "TRUE". This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition. * **key** *(string) --* **[REQUIRED]** The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **attributeValueOperator** *(string) --* "TRUE" to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to "TRUE". * **documentContentOperator** *(string) --* "TRUE" to delete content if the condition used for the target attribute is met. * **preExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **postExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **mediaExtractionConfiguration** *(dict) --* The configuration for extracting information from media in the document. * **imageExtractionConfiguration** *(dict) --* The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals. * **imageExtractionStatus** *(string) --* **[REQUIRED]** Specify whether to extract semantic meaning from images and visuals from documents. * **audioExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing audio content from media files. * **audioExtractionStatus** *(string) --* **[REQUIRED]** The status of audio extraction (ENABLED or DISABLED) for processing audio content from files. * **videoExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing video content from media files. * **videoExtractionStatus** *(string) --* **[REQUIRED]** The status of video extraction (ENABLED or DISABLED) for processing video content from files. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. * **dataSourceSyncId** (*string*) -- The identifier of the data source sync during which the documents were added. Return type: dict Returns: **Response Syntax** { 'failedDocuments': [ { 'id': 'string', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'dataSourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **failedDocuments** *(list) --* A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index. * *(dict) --* A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index. * **id** *(string) --* The identifier of the document that couldn't be removed from the Amazon Q Business index. * **error** *(dict) --* An explanation for why the document couldn't be removed from the index. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **dataSourceId** *(string) --* The identifier of the Amazon Q Business data source connector that contains the failed document. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_subscriptions list_subscriptions ****************** QBusiness.Client.list_subscriptions(**kwargs) Lists all subscriptions created in an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.list_subscriptions( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the subscription. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions. * **maxResults** (*integer*) -- The maximum number of Amazon Q Business subscriptions to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'subscriptions': [ { 'subscriptionId': 'string', 'subscriptionArn': 'string', 'principal': { 'user': 'string', 'group': 'string' }, 'currentSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' }, 'nextSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' } }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions. * **subscriptions** *(list) --* An array of summary information on the subscriptions configured for an Amazon Q Business application. * *(dict) --* Information about an Amazon Q Business subscription. Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application. Amazon Q Business offers two subscription tiers: "Q_LITE" and "Q_BUSINESS". Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. * **subscriptionId** *(string) --* The identifier of the Amazon Q Business subscription to be updated. * **subscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated. * **principal** *(dict) --* The IAM Identity Center "UserId" or "GroupId" of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "user", "group". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **user** *(string) --* The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application. * **group** *(string) --* The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application. * **currentSubscription** *(dict) --* The type of your current Amazon Q Business subscription. * **type** *(string) --* The type of an Amazon Q Business subscription. * **nextSubscription** *(dict) --* The type of the Amazon Q Business subscription for the next month. * **type** *(string) --* The type of an Amazon Q Business subscription. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_plugin update_plugin ************* QBusiness.Client.update_plugin(**kwargs) Updates an Amazon Q Business plugin. See also: AWS API Documentation **Request Syntax** response = client.update_plugin( applicationId='string', pluginId='string', displayName='string', state='ENABLED'|'DISABLED', serverUrl='string', customPluginConfiguration={ 'description': 'string', 'apiSchemaType': 'OPEN_API_V3', 'apiSchema': { 'payload': 'string', 's3': { 'bucket': 'string', 'key': 'string' } } }, authConfiguration={ 'basicAuthConfiguration': { 'secretArn': 'string', 'roleArn': 'string' }, 'oAuth2ClientCredentialConfiguration': { 'secretArn': 'string', 'roleArn': 'string', 'authorizationUrl': 'string', 'tokenUrl': 'string' }, 'noAuthConfiguration': {} , 'idcAuthConfiguration': { 'idcApplicationArn': 'string', 'roleArn': 'string' } } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application the plugin is attached to. * **pluginId** (*string*) -- **[REQUIRED]** The identifier of the plugin. * **displayName** (*string*) -- The name of the plugin. * **state** (*string*) -- The status of the plugin. * **serverUrl** (*string*) -- The source URL used for plugin configuration. * **customPluginConfiguration** (*dict*) -- The configuration for a custom plugin. * **description** *(string) --* **[REQUIRED]** A description for your custom plugin configuration. * **apiSchemaType** *(string) --* **[REQUIRED]** The type of OpenAPI schema to use. * **apiSchema** *(dict) --* Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML- formatted payload defining the schema. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "payload", "s3". * **payload** *(string) --* The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. * **s3** *(dict) --* Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format. * **bucket** *(string) --* **[REQUIRED]** The name of the S3 bucket that contains the file. * **key** *(string) --* **[REQUIRED]** The name of the file. * **authConfiguration** (*dict*) -- The authentication configuration the plugin is using. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "basicAuthConfiguration", "oAuth2ClientCredentialConfiguration", "noAuthConfiguration", "idcAuthConfiguration". * **basicAuthConfiguration** *(dict) --* Information about the basic authentication credentials used to configure a plugin. * **secretArn** *(string) --* **[REQUIRED]** The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration.. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. * **oAuth2ClientCredentialConfiguration** *(dict) --* Information about the OAuth 2.0 authentication credential/token used to configure a plugin. * **secretArn** *(string) --* **[REQUIRED]** The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration. * **roleArn** *(string) --* **[REQUIRED]** The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret. * **authorizationUrl** *(string) --* The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server. * **tokenUrl** *(string) --* The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token. * **noAuthConfiguration** *(dict) --* Information about invoking a custom plugin without any authentication. * **idcAuthConfiguration** *(dict) --* Information about the IAM Identity Center Application used to configure authentication for a plugin. * **idcApplicationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication. * **roleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / create_chat_response_configuration create_chat_response_configuration ********************************** QBusiness.Client.create_chat_response_configuration(**kwargs) Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions. See also: AWS API Documentation **Request Syntax** response = client.create_chat_response_configuration( applicationId='string', displayName='string', clientToken='string', responseConfigurations={ 'string': { 'instructionCollection': { 'responseLength': 'string', 'targetAudience': 'string', 'perspective': 'string', 'outputStyle': 'string', 'identity': 'string', 'tone': 'string', 'customInstructions': 'string', 'examples': 'string' } } }, tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application for which to create the new chat response configuration. * **displayName** (*string*) -- **[REQUIRED]** A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur. This field is autopopulated if not provided. * **responseConfigurations** (*dict*) -- **[REQUIRED]** A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions. * *(string) --* * *(dict) --* Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics. * **instructionCollection** *(dict) --* A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions. * **responseLength** *(string) --* Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive. * **targetAudience** *(string) --* Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge. * **perspective** *(string) --* Determines the point of view or perspective from which Amazon Q Business generates responses, such as first- person, second-person, or third-person perspective, affecting how information is presented to users. * **outputStyle** *(string) --* Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by- step instructions, or other organizational formats that enhance readability and comprehension. * **identity** *(string) --* Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization. * **tone** *(string) --* Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations. * **customInstructions** *(string) --* Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation. * **examples** *(string) --* Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries. * **tags** (*list*) -- A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. Return type: dict Returns: **Response Syntax** { 'chatResponseConfigurationId': 'string', 'chatResponseConfigurationArn': 'string' } **Response Structure** * *(dict) --* * **chatResponseConfigurationId** *(string) --* The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource. * **chatResponseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / update_web_experience update_web_experience ********************* QBusiness.Client.update_web_experience(**kwargs) Updates an Amazon Q Business web experience. See also: AWS API Documentation **Request Syntax** response = client.update_web_experience( applicationId='string', webExperienceId='string', roleArn='string', authenticationConfiguration={ 'samlConfiguration': { 'metadataXML': 'string', 'roleArn': 'string', 'userIdAttribute': 'string', 'userGroupAttribute': 'string' } }, title='string', subtitle='string', welcomeMessage='string', samplePromptsControlMode='ENABLED'|'DISABLED', identityProviderConfiguration={ 'samlConfiguration': { 'authenticationUrl': 'string' }, 'openIDConnectConfiguration': { 'secretsArn': 'string', 'secretsRole': 'string' } }, origins=[ 'string', ], browserExtensionConfiguration={ 'enabledBrowserExtensions': [ 'FIREFOX'|'CHROME', ] }, customizationConfiguration={ 'customCSSUrl': 'string', 'logoUrl': 'string', 'fontUrl': 'string', 'faviconUrl': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application attached to the web experience. * **webExperienceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources. * **authenticationConfiguration** (*dict*) -- The authentication configuration of the Amazon Q Business web experience. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "samlConfiguration". * **samlConfiguration** *(dict) --* Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience. * **metadataXML** *(string) --* **[REQUIRED]** The metadata XML that your IdP generated. * **roleArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business. * **userIdAttribute** *(string) --* **[REQUIRED]** The user attribute name in your IdP that maps to the user email. * **userGroupAttribute** *(string) --* The group attribute name in your IdP that maps to user groups. * **title** (*string*) -- The title of the Amazon Q Business web experience. * **subtitle** (*string*) -- The subtitle of the Amazon Q Business web experience. * **welcomeMessage** (*string*) -- A customized welcome message for an end user in an Amazon Q Business web experience. * **samplePromptsControlMode** (*string*) -- Determines whether sample prompts are enabled in the web experience for an end user. * **identityProviderConfiguration** (*dict*) -- Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "samlConfiguration", "openIDConnectConfiguration". * **samlConfiguration** *(dict) --* Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **authenticationUrl** *(string) --* **[REQUIRED]** The URL where Amazon Q Business end users will be redirected for authentication. * **openIDConnectConfiguration** *(dict) --* Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **secretsArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret. * **secretsRole** *(string) --* **[REQUIRED]** An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret. * **origins** (*list*) -- Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the *base URL* for accessing a website including the protocol ( "http/https"), the domain name, and the port number (if specified). Note: * Any values except "null" submitted as part of this update will replace all previous values. * You must only submit a *base URL* and not a full path. For example, "https://docs.aws.amazon.com". * *(string) --* * **browserExtensionConfiguration** (*dict*) -- The browser extension configuration for an Amazon Q Business web experience. Note: For Amazon Q Business application using external OIDC- compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions.. * **enabledBrowserExtensions** *(list) --* **[REQUIRED]** Specify the browser extensions allowed for your Amazon Q web experience. * "CHROME" — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). * "FIREFOX" — Enables the extension for Mozilla Firefox. * "CHROME" and "FIREFOX" — Enable the extension for Chromium-based browsers and Mozilla Firefox. * *(string) --* * **customizationConfiguration** (*dict*) -- Updates the custom logo, favicon, font, and color used in the Amazon Q web experience. * **customCSSUrl** *(string) --* Provides the URL where the custom CSS file is hosted for an Amazon Q web experience. * **logoUrl** *(string) --* Provides the URL where the custom logo file is hosted for an Amazon Q web experience. * **fontUrl** *(string) --* Provides the URL where the custom font file is hosted for an Amazon Q web experience. * **faviconUrl** *(string) --* Provides the URL where the custom favicon file is hosted for an Amazon Q web experience. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_data_source delete_data_source ****************** QBusiness.Client.delete_data_source(**kwargs) Deletes an Amazon Q Business data source connector. While the data source is being deleted, the "Status" field returned by a call to the "DescribeDataSource" API is set to "DELETING". See also: AWS API Documentation **Request Syntax** response = client.delete_data_source( applicationId='string', indexId='string', dataSourceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application used with the data source connector. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with the data source connector. * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_user update_user *********** QBusiness.Client.update_user(**kwargs) Updates a information associated with a user id. See also: AWS API Documentation **Request Syntax** response = client.update_user( applicationId='string', userId='string', userAliasesToUpdate=[ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ], userAliasesToDelete=[ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ] ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application the user is attached to. * **userId** (*string*) -- **[REQUIRED]** The email id attached to the user. * **userAliasesToUpdate** (*list*) -- The user aliases attached to the user id that are to be updated. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* **[REQUIRED]** The identifier of the user id associated with the user aliases. * **userAliasesToDelete** (*list*) -- The user aliases attached to the user id that are to be deleted. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* **[REQUIRED]** The identifier of the user id associated with the user aliases. Return type: dict Returns: **Response Syntax** { 'userAliasesAdded': [ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ], 'userAliasesUpdated': [ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ], 'userAliasesDeleted': [ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ] } **Response Structure** * *(dict) --* * **userAliasesAdded** *(list) --* The user aliases that have been to be added to a user id. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* The identifier of the user id associated with the user aliases. * **userAliasesUpdated** *(list) --* The user aliases attached to a user id that have been updated. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* The identifier of the user id associated with the user aliases. * **userAliasesDeleted** *(list) --* The user aliases that have been deleted from a user id. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* The identifier of the user id associated with the user aliases. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_plugin_type_actions list_plugin_type_actions ************************ QBusiness.Client.list_plugin_type_actions(**kwargs) Lists configured Amazon Q Business actions for any plugin type—both built-in and custom. See also: AWS API Documentation **Request Syntax** response = client.list_plugin_type_actions( pluginType='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', nextToken='string', maxResults=123 ) Parameters: * **pluginType** (*string*) -- **[REQUIRED]** The type of the plugin. * **nextToken** (*string*) -- If the number of plugins returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins. * **maxResults** (*integer*) -- The maximum number of plugins to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'items': [ { 'actionIdentifier': 'string', 'displayName': 'string', 'instructionExample': 'string', 'description': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins. * **items** *(list) --* An array of information on one or more plugins. * *(dict) --* Summary information for an Amazon Q Business plugin action. * **actionIdentifier** *(string) --* The identifier of an Amazon Q Business plugin action. * **displayName** *(string) --* The display name assigned by Amazon Q Business to a plugin action. You can't modify this value. * **instructionExample** *(string) --* An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example: * Create a Jira task * Create a chat assistant task to find the root cause of a specific incident * **description** *(string) --* The description of an Amazon Q Business plugin action. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_retriever get_retriever ************* QBusiness.Client.get_retriever(**kwargs) Gets information about an existing retriever used by an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.get_retriever( applicationId='string', retrieverId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application using the retriever. * **retrieverId** (*string*) -- **[REQUIRED]** The identifier of the retriever. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'retrieverId': 'string', 'retrieverArn': 'string', 'type': 'NATIVE_INDEX'|'KENDRA_INDEX', 'status': 'CREATING'|'ACTIVE'|'FAILED', 'displayName': 'string', 'configuration': { 'nativeIndexConfiguration': { 'indexId': 'string', 'version': 123, 'boostingOverride': { 'string': { 'numberConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES' }, 'stringConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'attributeValueBoosting': { 'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE' } }, 'dateConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingDurationInSeconds': 123 }, 'stringListConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO' } } } }, 'kendraIndexConfiguration': { 'indexId': 'string' } }, 'roleArn': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the Amazon Q Business application using the retriever. * **retrieverId** *(string) --* The identifier of the retriever. * **retrieverArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role associated with the retriever. * **type** *(string) --* The type of the retriever. * **status** *(string) --* The status of the retriever. * **displayName** *(string) --* The name of the retriever. * **configuration** *(dict) --* Provides information on how the retriever used for your Amazon Q Business application is configured. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "nativeIndexConfiguration", "kendraIndexConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **nativeIndexConfiguration** *(dict) --* Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* The identifier for the Amazon Q Business index. * **version** *(integer) --* A read-only field that specifies the version of the "NativeIndexConfiguration". Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of "NativeIndexConfiguration", focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1: * Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting * Version 2 supports a single String field with an ordered list of up to 5 values * Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels * Version 2 allows specifying prioritization between Date and String fields * Version 2 maintains backward compatibility with existing configurations * **boostingOverride** *(dict) --* Overrides the default boosts applied by Amazon Q Business to supported document attribute data types. * *(string) --* * *(dict) --* Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes. In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results. Note: For "STRING" and "STRING_LIST" type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "numberConfiguration", "stringConfiguration", "dateConfiguration", "stringListConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **numberConfiguration** *(dict) --* Provides information on boosting "NUMBER" type document attributes. "NUMBER" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "NUMBER" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **boostingType** *(string) --* Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important). * **stringConfiguration** *(dict) --* Provides information on boosting "STRING" type document attributes. Version 2 assigns priority tiers to "STRING" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **attributeValueBoosting** *(dict) --* Specifies specific values of a "STRING" type document attribute being boosted. When using "NativeIndexConfiguration" version 2, you can specify up to five values in order of priority. * *(string) --* * *(string) --* * **dateConfiguration** *(dict) --* Provides information on boosting "DATE" type document attributes. Version 2 assigns priority tiers to "DATE" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **boostingDurationInSeconds** *(integer) --* Specifies the duration, in seconds, of a boost applies to a "DATE" type document attribute. * **stringListConfiguration** *(dict) --* Provides information on boosting "STRING_LIST" type document attributes. "STRING_LIST" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "STRING_LIST" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **kendraIndexConfiguration** *(dict) --* Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* The identifier of the Amazon Kendra index. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources. * **createdAt** *(datetime) --* The Unix timestamp when the retriever was created. * **updatedAt** *(datetime) --* The Unix timestamp when the retriever was last updated. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_data_source create_data_source ****************** QBusiness.Client.create_data_source(**kwargs) Creates a data source connector for an Amazon Q Business application. "CreateDataSource" is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. See also: AWS API Documentation **Request Syntax** response = client.create_data_source( applicationId='string', indexId='string', displayName='string', configuration={...}|[...]|123|123.4|'string'|True|None, vpcConfiguration={ 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] }, description='string', tags=[ { 'key': 'string', 'value': 'string' }, ], syncSchedule='string', roleArn='string', clientToken='string', documentEnrichmentConfiguration={ 'inlineConfigurations': [ { 'condition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'target': { 'key': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) }, 'attributeValueOperator': 'DELETE' }, 'documentContentOperator': 'DELETE' }, ], 'preExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' }, 'postExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' } }, mediaExtractionConfiguration={ 'imageExtractionConfiguration': { 'imageExtractionStatus': 'ENABLED'|'DISABLED' }, 'audioExtractionConfiguration': { 'audioExtractionStatus': 'ENABLED'|'DISABLED' }, 'videoExtractionConfiguration': { 'videoExtractionStatus': 'ENABLED'|'DISABLED' } } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the data source will be attached to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index that you want to use with the data source connector. * **displayName** (*string*) -- **[REQUIRED]** A name for the data source connector. * **configuration** (*document*) -- **[REQUIRED]** Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector. Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas: * Amazon S3 JSON schema * Web Crawler JSON schema You can find configuration templates for your specific data source using the following steps: * Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice. * Then, from your specific data source connector page, select **Using the API**. You will find the JSON schema for your data source, including parameter descriptions, in this section. * **vpcConfiguration** (*dict*) -- Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors. * **subnetIds** *(list) --* **[REQUIRED]** A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device. * *(string) --* * **securityGroupIds** *(list) --* **[REQUIRED]** A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source. * *(string) --* * **description** (*string*) -- A description for the data source connector. * **tags** (*list*) -- A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. * **syncSchedule** (*string*) -- Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a "cron-" format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the "Schedule" parameter when the "Type" parameter is set to "CUSTOM". If you do, you receive a "ValidationException" exception. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. * **clientToken** (*string*) -- A token you provide to identify a request to create a data source connector. Multiple calls to the "CreateDataSource" API with the same client token will create only one data source connector. This field is autopopulated if not provided. * **documentEnrichmentConfiguration** (*dict*) -- Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment. * **inlineConfigurations** *(list) --* Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business. * *(dict) --* Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration. For more information, see Custom document enrichment. * **condition** *(dict) --* The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using "DocumentAttributeTarget". Amazon Q Business then will map your newly created metadata field to your index field. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **target** *(dict) --* The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to "TRUE". This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition. * **key** *(string) --* **[REQUIRED]** The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **attributeValueOperator** *(string) --* "TRUE" to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to "TRUE". * **documentContentOperator** *(string) --* "TRUE" to delete content if the condition used for the target attribute is met. * **preExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **postExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **mediaExtractionConfiguration** (*dict*) -- The configuration for extracting information from media in documents during ingestion. * **imageExtractionConfiguration** *(dict) --* The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals. * **imageExtractionStatus** *(string) --* **[REQUIRED]** Specify whether to extract semantic meaning from images and visuals from documents. * **audioExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing audio content from media files. * **audioExtractionStatus** *(string) --* **[REQUIRED]** The status of audio extraction (ENABLED or DISABLED) for processing audio content from files. * **videoExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing video content from media files. * **videoExtractionStatus** *(string) --* **[REQUIRED]** The status of video extraction (ENABLED or DISABLED) for processing video content from files. Return type: dict Returns: **Response Syntax** { 'dataSourceId': 'string', 'dataSourceArn': 'string' } **Response Structure** * *(dict) --* * **dataSourceId** *(string) --* The identifier of the data source connector. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / update_data_source update_data_source ****************** QBusiness.Client.update_data_source(**kwargs) Updates an existing Amazon Q Business data source connector. See also: AWS API Documentation **Request Syntax** response = client.update_data_source( applicationId='string', indexId='string', dataSourceId='string', displayName='string', configuration={...}|[...]|123|123.4|'string'|True|None, vpcConfiguration={ 'subnetIds': [ 'string', ], 'securityGroupIds': [ 'string', ] }, description='string', syncSchedule='string', roleArn='string', documentEnrichmentConfiguration={ 'inlineConfigurations': [ { 'condition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'target': { 'key': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) }, 'attributeValueOperator': 'DELETE' }, 'documentContentOperator': 'DELETE' }, ], 'preExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' }, 'postExtractionHookConfiguration': { 'invocationCondition': { 'key': 'string', 'operator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS'|'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS'|'EXISTS'|'NOT_EXISTS'|'BEGINS_WITH', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lambdaArn': 'string', 's3BucketName': 'string', 'roleArn': 'string' } }, mediaExtractionConfiguration={ 'imageExtractionConfiguration': { 'imageExtractionStatus': 'ENABLED'|'DISABLED' }, 'audioExtractionConfiguration': { 'audioExtractionStatus': 'ENABLED'|'DISABLED' }, 'videoExtractionConfiguration': { 'videoExtractionStatus': 'ENABLED'|'DISABLED' } } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the data source is attached to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index attached to the data source connector. * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. * **displayName** (*string*) -- A name of the data source connector. * **configuration** (*document*) -- Provides the configuration information for an Amazon Q Business data source. * **vpcConfiguration** (*dict*) -- Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud). * **subnetIds** *(list) --* **[REQUIRED]** A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device. * *(string) --* * **securityGroupIds** *(list) --* **[REQUIRED]** A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source. * *(string) --* * **description** (*string*) -- The description of the data source connector. * **syncSchedule** (*string*) -- The chosen update frequency for your data source. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. * **documentEnrichmentConfiguration** (*dict*) -- Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment. * **inlineConfigurations** *(list) --* Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business. * *(dict) --* Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration. For more information, see Custom document enrichment. * **condition** *(dict) --* The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition. For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using "DocumentAttributeTarget". Amazon Q Business then will map your newly created metadata field to your index field. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **target** *(dict) --* The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to "TRUE". This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata. Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business will then map your newly created document attribute to your index field. You can also use this with DocumentAttributeCondition. * **key** *(string) --* **[REQUIRED]** The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **attributeValueOperator** *(string) --* "TRUE" to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to "TRUE". * **documentContentOperator** *(string) --* "TRUE" to delete content if the condition used for the target attribute is met. * **preExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **postExtractionHookConfiguration** *(dict) --* Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. You can configure your Lambda function using the "PreExtractionHookConfiguration" parameter if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using "PostExtractionHookConfiguration". You can only invoke one Lambda function. However, this function can invoke other functions it requires. For more information, see Custom document enrichment. * **invocationCondition** *(dict) --* The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time. * **key** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support "_document_body" as an attribute key used for the condition. * **operator** *(string) --* **[REQUIRED]** The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support "_document_body" as an attribute key used for the condition. * **value** *(dict) --* The value of a document attribute. You can only provide one value for a document attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lambdaArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment. * **s3BucketName** *(string) --* Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of a role with permission to run "PreExtractionHookConfiguration" and "PostExtractionHookConfiguration" for altering document metadata and content during the document ingestion process. * **mediaExtractionConfiguration** (*dict*) -- The configuration for extracting information from media in documents for your data source. * **imageExtractionConfiguration** *(dict) --* The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals. * **imageExtractionStatus** *(string) --* **[REQUIRED]** Specify whether to extract semantic meaning from images and visuals from documents. * **audioExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing audio content from media files. * **audioExtractionStatus** *(string) --* **[REQUIRED]** The status of audio extraction (ENABLED or DISABLED) for processing audio content from files. * **videoExtractionConfiguration** *(dict) --* Configuration settings for extracting and processing video content from media files. * **videoExtractionStatus** *(string) --* **[REQUIRED]** The status of video extraction (ENABLED or DISABLED) for processing video content from files. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / associate_permission associate_permission ******************** QBusiness.Client.associate_permission(**kwargs) Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources. See also: AWS API Documentation **Request Syntax** response = client.associate_permission( applicationId='string', statementId='string', actions=[ 'string', ], conditions=[ { 'conditionOperator': 'StringEquals', 'conditionKey': 'string', 'conditionValues': [ 'string', ] }, ], principal='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **statementId** (*string*) -- **[REQUIRED]** A unique identifier for the policy statement. * **actions** (*list*) -- **[REQUIRED]** The list of Amazon Q Business actions that the ISV is allowed to perform. * *(string) --* * **conditions** (*list*) -- The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request. * *(dict) --* Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request. * **conditionOperator** *(string) --* **[REQUIRED]** The operator to use for the condition evaluation. This determines how the condition values are compared. * **conditionKey** *(string) --* **[REQUIRED]** The key for the condition. This identifies the attribute that the condition applies to. * **conditionValues** *(list) --* **[REQUIRED]** The values to compare against using the specified condition operator. * *(string) --* * **principal** (*string*) -- **[REQUIRED]** The Amazon Resource Name of the IAM role for the ISV that is being granted permission. Return type: dict Returns: **Response Syntax** { 'statement': 'string' } **Response Structure** * *(dict) --* * **statement** *(string) --* The JSON representation of the added permission statement. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / delete_chat_controls_configuration delete_chat_controls_configuration ********************************** QBusiness.Client.delete_chat_controls_configuration(**kwargs) Deletes chat controls configured for an existing Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.delete_chat_controls_configuration( applicationId='string' ) Parameters: **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application the chat controls have been configured for. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_group delete_group ************ QBusiness.Client.delete_group(**kwargs) 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. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the "PutGroup" operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling "PutGroup". See also: AWS API Documentation **Request Syntax** response = client.delete_group( applicationId='string', indexId='string', groupName='string', dataSourceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application in which the group mapping belongs. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index you want to delete the group from. * **groupName** (*string*) -- **[REQUIRED]** The name of the group you want to delete. * **dataSourceId** (*string*) -- The identifier of the data source linked to the group A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_document_content get_document_content ******************** QBusiness.Client.get_document_content(**kwargs) Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL. See also: AWS API Documentation **Request Syntax** response = client.get_document_content( applicationId='string', indexId='string', dataSourceId='string', documentId='string', outputFormat='RAW' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index where documents are indexed. * **dataSourceId** (*string*) -- The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat- datasourceid". * **documentId** (*string*) -- **[REQUIRED]** The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response. * **outputFormat** (*string*) -- Raw document outputFormat. Return type: dict Returns: **Response Syntax** { 'presignedUrl': 'string', 'mimeType': 'string' } **Response Structure** * *(dict) --* * **presignedUrl** *(string) --* A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation. * **mimeType** *(string) --* The MIME type of the document content (e.g., application/pdf, text/plain, application/vnd.openxmlformats- officedocument.wordprocessingml.document). **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_user create_user *********** QBusiness.Client.create_user(**kwargs) Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application. See also: AWS API Documentation **Request Syntax** response = client.create_user( applicationId='string', userId='string', userAliases=[ { 'indexId': 'string', 'dataSourceId': 'string', 'userId': 'string' }, ], clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for which the user mapping will be created. * **userId** (*string*) -- **[REQUIRED]** The user emails attached to a user mapping. * **userAliases** (*list*) -- The list of user aliases in the mapping. * *(dict) --* Aliases attached to a user id within an Amazon Q Business application. * **indexId** *(string) --* The identifier of the index that the user aliases are associated with. * **dataSourceId** *(string) --* The identifier of the data source that the user aliases are associated with. * **userId** *(string) --* **[REQUIRED]** The identifier of the user id associated with the user aliases. * **clientToken** (*string*) -- A token that you provide to identify the request to create your Amazon Q Business user mapping. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / delete_index delete_index ************ QBusiness.Client.delete_index(**kwargs) Deletes an Amazon Q Business index. See also: AWS API Documentation **Request Syntax** response = client.delete_index( applicationId='string', indexId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the Amazon Q Business index is linked to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business index. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_data_accessors list_data_accessors ******************* QBusiness.Client.list_data_accessors(**kwargs) Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor. See also: AWS API Documentation **Request Syntax** response = client.list_data_accessors( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **nextToken** (*string*) -- The token for the next set of results. (You received this token from a previous call.) * **maxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'dataAccessors': [ { 'displayName': 'string', 'dataAccessorId': 'string', 'dataAccessorArn': 'string', 'idcApplicationArn': 'string', 'principal': 'string', 'authenticationDetail': { 'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE', 'authenticationConfiguration': { 'idcTrustedTokenIssuerConfiguration': { 'idcTrustedTokenIssuerArn': 'string' } }, 'externalIds': [ 'string', ] }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **dataAccessors** *(list) --* The list of data accessors. * *(dict) --* Provides summary information about a data accessor. * **displayName** *(string) --* The friendly name of the data accessor. * **dataAccessorId** *(string) --* The unique identifier of the data accessor. * **dataAccessorArn** *(string) --* The Amazon Resource Name (ARN) of the data accessor. * **idcApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the associated IAM Identity Center application. * **principal** *(string) --* The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. * **authenticationDetail** *(dict) --* The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor. * **authenticationType** *(string) --* The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: * "AWS_IAM_IDC_TTI" - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. * "AWS_IAM_IDC_AUTH_CODE" - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. * **authenticationConfiguration** *(dict) --* The specific authentication configuration based on the authentication type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "idcTrustedTokenIssuerConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **idcTrustedTokenIssuerConfiguration** *(dict) --* Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is "AWS_IAM_IDC_TTI". * **idcTrustedTokenIssuerArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. * **externalIds** *(list) --* A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. * *(string) --* * **createdAt** *(datetime) --* The timestamp when the data accessor was created. * **updatedAt** *(datetime) --* The timestamp when the data accessor was last updated. * **nextToken** *(string) --* The token to use to retrieve the next set of results, if there are any. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_data_accessor delete_data_accessor ******************** QBusiness.Client.delete_data_accessor(**kwargs) Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked. See also: AWS API Documentation **Request Syntax** response = client.delete_data_accessor( applicationId='string', dataAccessorId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **dataAccessorId** (*string*) -- **[REQUIRED]** The unique identifier of the data accessor to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_tags_for_resource list_tags_for_resource ********************** QBusiness.Client.list_tags_for_resource(**kwargs) Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceARN='string' ) Parameters: **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* A list of tags associated with the Amazon Q Business application or data source. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* The value associated with the tag. The value may be an empty string but it can't be null. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_documents list_documents ************** QBusiness.Client.list_documents(**kwargs) A list of documents attached to an index. See also: AWS API Documentation **Request Syntax** response = client.list_documents( applicationId='string', indexId='string', dataSourceIds=[ 'string', ], nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application id the documents are attached to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index the documents are attached to. * **dataSourceIds** (*list*) -- The identifier of the data sources the documents are attached to. * *(string) --* * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents. * **maxResults** (*integer*) -- The maximum number of documents to return. Return type: dict Returns: **Response Syntax** { 'documentDetailList': [ { 'documentId': 'string', 'status': 'RECEIVED'|'PROCESSING'|'INDEXED'|'UPDATED'|'FAILED'|'DELETING'|'DELETED'|'DOCUMENT_FAILED_TO_INDEX', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **documentDetailList** *(list) --* A list of document details. * *(dict) --* The details of a document within an Amazon Q Business index. * **documentId** *(string) --* The identifier of the document. * **status** *(string) --* The current status of the document. * **error** *(dict) --* An error message associated with the document. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **createdAt** *(datetime) --* The timestamp for when the document was created. * **updatedAt** *(datetime) --* The timestamp for when the document was last updated. * **nextToken** *(string) --* If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_chat_response_configuration get_chat_response_configuration ******************************* QBusiness.Client.get_chat_response_configuration(**kwargs) Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata. See also: AWS API Documentation **Request Syntax** response = client.get_chat_response_configuration( applicationId='string', chatResponseConfigurationId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve. * **chatResponseConfigurationId** (*string*) -- **[REQUIRED]** The unique identifier of the chat response configuration to retrieve from the specified application. Return type: dict Returns: **Response Syntax** { 'chatResponseConfigurationId': 'string', 'chatResponseConfigurationArn': 'string', 'displayName': 'string', 'createdAt': datetime(2015, 1, 1), 'inUseConfiguration': { 'responseConfigurations': { 'string': { 'instructionCollection': { 'responseLength': 'string', 'targetAudience': 'string', 'perspective': 'string', 'outputStyle': 'string', 'identity': 'string', 'tone': 'string', 'customInstructions': 'string', 'examples': 'string' } } }, 'responseConfigurationSummary': 'string', 'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'updatedAt': datetime(2015, 1, 1) }, 'lastUpdateConfiguration': { 'responseConfigurations': { 'string': { 'instructionCollection': { 'responseLength': 'string', 'targetAudience': 'string', 'perspective': 'string', 'outputStyle': 'string', 'identity': 'string', 'tone': 'string', 'customInstructions': 'string', 'examples': 'string' } } }, 'responseConfigurationSummary': 'string', 'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'updatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **chatResponseConfigurationId** *(string) --* The unique identifier of the retrieved chat response configuration. * **chatResponseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services. * **displayName** *(string) --* The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations. * **createdAt** *(datetime) --* The timestamp indicating when the chat response configuration was initially created. * **inUseConfiguration** *(dict) --* The currently active configuration settings that are being used to generate responses in the Amazon Q Business application. * **responseConfigurations** *(dict) --* A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions. * *(string) --* * *(dict) --* Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics. * **instructionCollection** *(dict) --* A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions. * **responseLength** *(string) --* Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive. * **targetAudience** *(string) --* Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge. * **perspective** *(string) --* Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users. * **outputStyle** *(string) --* Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension. * **identity** *(string) --* Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization. * **tone** *(string) --* Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations. * **customInstructions** *(string) --* Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation. * **examples** *(string) --* Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries. * **responseConfigurationSummary** *(string) --* A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior. * **status** *(string) --* The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use. * **error** *(dict) --* Provides information about a Amazon Q Business request error. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **updatedAt** *(datetime) --* The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness. * **lastUpdateConfiguration** *(dict) --* Information about the most recent update to the configuration, including timestamp and modification details. * **responseConfigurations** *(dict) --* A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions. * *(string) --* * *(dict) --* Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics. * **instructionCollection** *(dict) --* A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions. * **responseLength** *(string) --* Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive. * **targetAudience** *(string) --* Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge. * **perspective** *(string) --* Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users. * **outputStyle** *(string) --* Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension. * **identity** *(string) --* Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization. * **tone** *(string) --* Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations. * **customInstructions** *(string) --* Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation. * **examples** *(string) --* Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries. * **responseConfigurationSummary** *(string) --* A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior. * **status** *(string) --* The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use. * **error** *(dict) --* Provides information about a Amazon Q Business request error. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **updatedAt** *(datetime) --* The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_web_experience get_web_experience ****************** QBusiness.Client.get_web_experience(**kwargs) Gets information about an existing Amazon Q Business web experience. See also: AWS API Documentation **Request Syntax** response = client.get_web_experience( applicationId='string', webExperienceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the web experience. * **webExperienceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'webExperienceId': 'string', 'webExperienceArn': 'string', 'defaultEndpoint': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'title': 'string', 'subtitle': 'string', 'welcomeMessage': 'string', 'samplePromptsControlMode': 'ENABLED'|'DISABLED', 'origins': [ 'string', ], 'roleArn': 'string', 'identityProviderConfiguration': { 'samlConfiguration': { 'authenticationUrl': 'string' }, 'openIDConnectConfiguration': { 'secretsArn': 'string', 'secretsRole': 'string' } }, 'authenticationConfiguration': { 'samlConfiguration': { 'metadataXML': 'string', 'roleArn': 'string', 'userIdAttribute': 'string', 'userGroupAttribute': 'string' } }, 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'browserExtensionConfiguration': { 'enabledBrowserExtensions': [ 'FIREFOX'|'CHROME', ] }, 'customizationConfiguration': { 'customCSSUrl': 'string', 'logoUrl': 'string', 'fontUrl': 'string', 'faviconUrl': 'string' } } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the Amazon Q Business application linked to the web experience. * **webExperienceId** *(string) --* The identifier of the Amazon Q Business web experience. * **webExperienceArn** *(string) --* The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources. * **defaultEndpoint** *(string) --* The endpoint of your Amazon Q Business web experience. * **status** *(string) --* The current status of the Amazon Q Business web experience. When the "Status" field value is "FAILED", the "ErrorMessage" field contains a description of the error that caused the data source connector to fail. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business web experience was last created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business web experience was last updated. * **title** *(string) --* The title for your Amazon Q Business web experience. * **subtitle** *(string) --* The subtitle for your Amazon Q Business web experience. * **welcomeMessage** *(string) --* The customized welcome message for end users of an Amazon Q Business web experience. * **samplePromptsControlMode** *(string) --* Determines whether sample prompts are enabled in the web experience for an end user. * **origins** *(list) --* Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol ( "http/https"), the domain name, and the port number (if specified). * *(string) --* * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the service role attached to your web experience. * **identityProviderConfiguration** *(dict) --* Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "samlConfiguration", "openIDConnectConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **samlConfiguration** *(dict) --* Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **authenticationUrl** *(string) --* The URL where Amazon Q Business end users will be redirected for authentication. * **openIDConnectConfiguration** *(dict) --* Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **secretsArn** *(string) --* The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret. * **secretsRole** *(string) --* An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret. * **authenticationConfiguration** *(dict) --* The authentication configuration information for your Amazon Q Business web experience. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "samlConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **samlConfiguration** *(dict) --* Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience. * **metadataXML** *(string) --* The metadata XML that your IdP generated. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business. * **userIdAttribute** *(string) --* The user attribute name in your IdP that maps to the user email. * **userGroupAttribute** *(string) --* The group attribute name in your IdP that maps to user groups. * **error** *(dict) --* When the "Status" field value is "FAILED", the "ErrorMessage" field contains a description of the error that caused the data source connector to fail. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **browserExtensionConfiguration** *(dict) --* The browser extension configuration for an Amazon Q Business web experience. * **enabledBrowserExtensions** *(list) --* Specify the browser extensions allowed for your Amazon Q web experience. * "CHROME" — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). * "FIREFOX" — Enables the extension for Mozilla Firefox. * "CHROME" and "FIREFOX" — Enable the extension for Chromium-based browsers and Mozilla Firefox. * *(string) --* * **customizationConfiguration** *(dict) --* Gets the custom logo, favicon, font, and color used in the Amazon Q web experience. * **customCSSUrl** *(string) --* Provides the URL where the custom CSS file is hosted for an Amazon Q web experience. * **logoUrl** *(string) --* Provides the URL where the custom logo file is hosted for an Amazon Q web experience. * **fontUrl** *(string) --* Provides the URL where the custom font file is hosted for an Amazon Q web experience. * **faviconUrl** *(string) --* Provides the URL where the custom favicon file is hosted for an Amazon Q web experience. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / untag_resource untag_resource ************** QBusiness.Client.untag_resource(**kwargs) Removes a tag from an Amazon Q Business application or a data source. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceARN='string', tagKeys=[ 'string', ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from. * **tagKeys** (*list*) -- **[REQUIRED]** A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / start_data_source_sync_job start_data_source_sync_job ************************** QBusiness.Client.start_data_source_sync_job(**kwargs) Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a "ConflictException". See also: AWS API Documentation **Request Syntax** response = client.start_data_source_sync_job( dataSourceId='string', applicationId='string', indexId='string' ) Parameters: * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. * **applicationId** (*string*) -- **[REQUIRED]** The identifier of Amazon Q Business application the data source is connected to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with the data source connector. Return type: dict Returns: **Response Syntax** { 'executionId': 'string' } **Response Structure** * *(dict) --* * **executionId** *(string) --* The identifier for a particular synchronization job. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_plugins list_plugins ************ QBusiness.Client.list_plugins(**kwargs) Lists configured Amazon Q Business plugins. See also: AWS API Documentation **Request Syntax** response = client.list_plugins( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application the plugin is attached to. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins. * **maxResults** (*integer*) -- The maximum number of documents to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'plugins': [ { 'pluginId': 'string', 'displayName': 'string', 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'serverUrl': 'string', 'state': 'ENABLED'|'DISABLED', 'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins. * **plugins** *(list) --* Information about a configured plugin. * *(dict) --* Information about an Amazon Q Business plugin and its configuration. * **pluginId** *(string) --* The identifier of the plugin. * **displayName** *(string) --* The name of the plugin. * **type** *(string) --* The type of the plugin. * **serverUrl** *(string) --* The plugin server URL used for configuration. * **state** *(string) --* The current status of the plugin. * **buildStatus** *(string) --* The status of the plugin. * **createdAt** *(datetime) --* The timestamp for when the plugin was created. * **updatedAt** *(datetime) --* The timestamp for when the plugin was last updated. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_data_sources list_data_sources ***************** QBusiness.Client.list_data_sources(**kwargs) Lists the Amazon Q Business data source connectors that you have created. See also: AWS API Documentation **Request Syntax** response = client.list_data_sources( applicationId='string', indexId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the data source connectors. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with one or more data source connectors. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors. * **maxResults** (*integer*) -- The maximum number of data source connectors to return. Return type: dict Returns: **Response Syntax** { 'dataSources': [ { 'displayName': 'string', 'dataSourceId': 'string', 'type': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'PENDING_CREATION'|'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **dataSources** *(list) --* An array of summary information for one or more data source connector. * *(dict) --* A data source in an Amazon Q Business application. * **displayName** *(string) --* The name of the Amazon Q Business data source. * **dataSourceId** *(string) --* The identifier of the Amazon Q Business data source. * **type** *(string) --* The type of the Amazon Q Business data source. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business data source was created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business data source was last updated. * **status** *(string) --* The status of the Amazon Q Business data source. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_waiter get_waiter ********** QBusiness.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" QBusiness / Client / get_media get_media ********* QBusiness.Client.get_media(**kwargs) Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals. See also: AWS API Documentation **Request Syntax** response = client.get_media( applicationId='string', conversationId='string', messageId='string', mediaId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business which contains the media object. * **conversationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business conversation. * **messageId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business message. * **mediaId** (*string*) -- **[REQUIRED]** The identifier of the media object. You can find this in the "sourceAttributions" returned by the "Chat", "ChatSync", and "ListMessages" API responses. Return type: dict Returns: **Response Syntax** { 'mediaBytes': b'bytes', 'mediaMimeType': 'string' } **Response Structure** * *(dict) --* * **mediaBytes** *(bytes) --* The base64-encoded bytes of the media object. * **mediaMimeType** *(string) --* The MIME type of the media object (image/png). **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.MediaTooLargeException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_conversations list_conversations ****************** QBusiness.Client.list_conversations(**kwargs) Lists one or more Amazon Q Business conversations. See also: AWS API Documentation **Request Syntax** response = client.list_conversations( applicationId='string', userId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **userId** (*string*) -- The identifier of the user involved in the Amazon Q Business web experience conversation. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations. * **maxResults** (*integer*) -- The maximum number of Amazon Q Business conversations to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'conversations': [ { 'conversationId': 'string', 'title': 'string', 'startTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages. * **conversations** *(list) --* An array of summary information on the configuration of one or more Amazon Q Business web experiences. * *(dict) --* A conversation in an Amazon Q Business application. * **conversationId** *(string) --* The identifier of the Amazon Q Business conversation. * **title** *(string) --* The title of the conversation. * **startTime** *(datetime) --* The start time of the conversation. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_anonymous_web_experience_url create_anonymous_web_experience_url *********************************** QBusiness.Client.create_anonymous_web_experience_url(**kwargs) Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated. See also: AWS API Documentation **Request Syntax** response = client.create_anonymous_web_experience_url( applicationId='string', webExperienceId='string', sessionDurationInMinutes=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application environment attached to the web experience. * **webExperienceId** (*string*) -- **[REQUIRED]** The identifier of the web experience. * **sessionDurationInMinutes** (*integer*) -- The duration of the session associated with the unique URL for the web experience. Return type: dict Returns: **Response Syntax** { 'anonymousUrl': 'string' } **Response Structure** * *(dict) --* * **anonymousUrl** *(string) --* The unique URL for accessing the web experience. Warning: This URL can only be used once and must be used within 5 minutes after it's generated. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_chat_response_configurations list_chat_response_configurations ********************************* QBusiness.Client.list_chat_response_configurations(**kwargs) Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings. See also: AWS API Documentation **Request Syntax** response = client.list_chat_response_configurations( applicationId='string', maxResults=123, nextToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application for which to list available chat response configurations. * **maxResults** (*integer*) -- The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist. * **nextToken** (*string*) -- A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified "maxResults" value. Return type: dict Returns: **Response Syntax** { 'chatResponseConfigurations': [ { 'chatResponseConfigurationId': 'string', 'chatResponseConfigurationArn': 'string', 'displayName': 'string', 'responseConfigurationSummary': 'string', 'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **chatResponseConfigurations** *(list) --* A list of chat response configuration summaries, each containing key information about an available configuration in the specified application. * *(dict) --* Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards. * **chatResponseConfigurationId** *(string) --* A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service. * **chatResponseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts. * **displayName** *(string) --* A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization. * **responseConfigurationSummary** *(string) --* A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted. * **status** *(string) --* The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions. * **createdAt** *(datetime) --* The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources. * **updatedAt** *(datetime) --* The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness. * **nextToken** *(string) --* A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the "maxResults" parameter. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_data_source_sync_jobs list_data_source_sync_jobs ************************** QBusiness.Client.list_data_source_sync_jobs(**kwargs) Get information about an Amazon Q Business data source connector synchronization. See also: AWS API Documentation **Request Syntax** response = client.list_data_source_sync_jobs( dataSourceId='string', applicationId='string', indexId='string', nextToken='string', maxResults=123, startTime=datetime(2015, 1, 1), endTime=datetime(2015, 1, 1), statusFilter='FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING' ) Parameters: * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the data source. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with the Amazon Q Business data source connector. * **nextToken** (*string*) -- If the "maxResults" response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses. * **maxResults** (*integer*) -- The maximum number of synchronization jobs to return in the response. * **startTime** (*datetime*) -- The start time of the data source connector sync. * **endTime** (*datetime*) -- The end time of the data source connector sync. * **statusFilter** (*string*) -- Only returns synchronization jobs with the "Status" field equal to the specified status. Return type: dict Returns: **Response Syntax** { 'history': [ { 'executionId': 'string', 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'status': 'FAILED'|'SUCCEEDED'|'SYNCING'|'INCOMPLETE'|'STOPPING'|'ABORTED'|'SYNCING_INDEXING', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'dataSourceErrorCode': 'string', 'metrics': { 'documentsAdded': 'string', 'documentsModified': 'string', 'documentsDeleted': 'string', 'documentsFailed': 'string', 'documentsScanned': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **history** *(list) --* A history of synchronization jobs for the data source connector. * *(dict) --* Provides information about an Amazon Q Business data source connector synchronization job. * **executionId** *(string) --* The identifier of a data source synchronization job. * **startTime** *(datetime) --* The Unix time stamp when the data source synchronization job started. * **endTime** *(datetime) --* The Unix timestamp when the synchronization job completed. * **status** *(string) --* The status of the synchronization job. When the "Status" field is set to "SUCCEEDED", the synchronization job is done. If the status code is "FAILED", the "ErrorCode" and "ErrorMessage" fields give you the reason for the failure. * **error** *(dict) --* If the "Status" field is set to "FAILED", the "ErrorCode" field indicates the reason the synchronization failed. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **dataSourceErrorCode** *(string) --* If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error. * **metrics** *(dict) --* Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector. * **documentsAdded** *(string) --* The current count of documents added from the data source during the data source sync. * **documentsModified** *(string) --* The current count of documents modified in the data source during the data source sync. * **documentsDeleted** *(string) --* The current count of documents deleted from the data source during the data source sync. * **documentsFailed** *(string) --* The current count of documents that failed to sync from the data source during the data source sync. * **documentsScanned** *(string) --* The current count of documents crawled by the ongoing sync job in the data source. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_user delete_user *********** QBusiness.Client.delete_user(**kwargs) Deletes a user by email id. See also: AWS API Documentation **Request Syntax** response = client.delete_user( applicationId='string', userId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application from which the user is being deleted. * **userId** (*string*) -- **[REQUIRED]** The user email being deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_data_accessor update_data_accessor ******************** QBusiness.Client.update_data_accessor(**kwargs) Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor. See also: AWS API Documentation **Request Syntax** response = client.update_data_accessor( applicationId='string', dataAccessorId='string', actionConfigurations=[ { 'action': 'string', 'filterConfiguration': { 'documentAttributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } } }, ], authenticationDetail={ 'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE', 'authenticationConfiguration': { 'idcTrustedTokenIssuerConfiguration': { 'idcTrustedTokenIssuerArn': 'string' } }, 'externalIds': [ 'string', ] }, displayName='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **dataAccessorId** (*string*) -- **[REQUIRED]** The unique identifier of the data accessor to update. * **actionConfigurations** (*list*) -- **[REQUIRED]** The updated list of action configurations specifying the allowed actions and any associated filters. * *(dict) --* Specifies an allowed action and its associated filter configuration. * **action** *(string) --* **[REQUIRED]** The Amazon Q Business action that is allowed. * **filterConfiguration** *(dict) --* The filter configuration for the action, if any. * **documentAttributeFilter** *(dict) --* **[REQUIRED]** Enables filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **authenticationDetail** (*dict*) -- The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor. * **authenticationType** *(string) --* **[REQUIRED]** The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: * "AWS_IAM_IDC_TTI" - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. * "AWS_IAM_IDC_AUTH_CODE" - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. * **authenticationConfiguration** *(dict) --* The specific authentication configuration based on the authentication type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "idcTrustedTokenIssuerConfiguration". * **idcTrustedTokenIssuerConfiguration** *(dict) --* Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is "AWS_IAM_IDC_TTI". * **idcTrustedTokenIssuerArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. * **externalIds** *(list) --* A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. * *(string) --* * **displayName** (*string*) -- The updated friendly name for the data accessor. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / disassociate_permission disassociate_permission *********************** QBusiness.Client.disassociate_permission(**kwargs) Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy. See also: AWS API Documentation **Request Syntax** response = client.disassociate_permission( applicationId='string', statementId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **statementId** (*string*) -- **[REQUIRED]** The statement ID of the permission to remove. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_chat_controls_configuration update_chat_controls_configuration ********************************** QBusiness.Client.update_chat_controls_configuration(**kwargs) Updates a set of chat controls configured for an existing Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.update_chat_controls_configuration( applicationId='string', clientToken='string', responseScope='ENTERPRISE_CONTENT_ONLY'|'EXTENDED_KNOWLEDGE_ENABLED', orchestrationConfiguration={ 'control': 'ENABLED'|'DISABLED' }, blockedPhrasesConfigurationUpdate={ 'blockedPhrasesToCreateOrUpdate': [ 'string', ], 'blockedPhrasesToDelete': [ 'string', ], 'systemMessageOverride': 'string' }, topicConfigurationsToCreateOrUpdate=[ { 'name': 'string', 'description': 'string', 'exampleChatMessages': [ 'string', ], 'rules': [ { 'includedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'excludedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'ruleType': 'CONTENT_BLOCKER_RULE'|'CONTENT_RETRIEVAL_RULE', 'ruleConfiguration': { 'contentBlockerRule': { 'systemMessageOverride': 'string' }, 'contentRetrievalRule': { 'eligibleDataSources': [ { 'indexId': 'string', 'dataSourceId': 'string' }, ] } } }, ] }, ], topicConfigurationsToDelete=[ { 'name': 'string', 'description': 'string', 'exampleChatMessages': [ 'string', ], 'rules': [ { 'includedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'excludedUsersAndGroups': { 'userIds': [ 'string', ], 'userGroups': [ 'string', ] }, 'ruleType': 'CONTENT_BLOCKER_RULE'|'CONTENT_RETRIEVAL_RULE', 'ruleConfiguration': { 'contentBlockerRule': { 'systemMessageOverride': 'string' }, 'contentRetrievalRule': { 'eligibleDataSources': [ { 'indexId': 'string', 'dataSourceId': 'string' }, ] } } }, ] }, ], creatorModeConfiguration={ 'creatorModeControl': 'ENABLED'|'DISABLED' }, hallucinationReductionConfiguration={ 'hallucinationReductionControl': 'ENABLED'|'DISABLED' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for which the chat controls are configured. * **clientToken** (*string*) -- A token that you provide to identify the request to update a Amazon Q Business application chat configuration. This field is autopopulated if not provided. * **responseScope** (*string*) -- The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat. * **orchestrationConfiguration** (*dict*) -- The chat response orchestration settings for your application. * **control** *(string) --* **[REQUIRED]** Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application. * **blockedPhrasesConfigurationUpdate** (*dict*) -- The phrases blocked from chat by your chat control configuration. * **blockedPhrasesToCreateOrUpdate** *(list) --* Creates or updates a blocked phrases configuration in your Amazon Q Business application. * *(string) --* * **blockedPhrasesToDelete** *(list) --* Deletes a blocked phrases configuration in your Amazon Q Business application. * *(string) --* * **systemMessageOverride** *(string) --* The configured custom message displayed to your end user when they use blocked phrase during chat. * **topicConfigurationsToCreateOrUpdate** (*list*) -- The configured topic specific chat controls you want to update. * *(dict) --* The topic specific controls configured for an Amazon Q Business application. * **name** *(string) --* **[REQUIRED]** A name for your topic control configuration. * **description** *(string) --* A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. * **exampleChatMessages** *(list) --* A list of example phrases that you expect the end user to use in relation to the topic. * *(string) --* * **rules** *(list) --* **[REQUIRED]** Rules defined for a topic configuration. * *(dict) --* Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time. * **includedUsersAndGroups** *(dict) --* Users and groups to be included in a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **excludedUsersAndGroups** *(dict) --* Users and groups to be excluded from a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **ruleType** *(string) --* **[REQUIRED]** The type of rule. * **ruleConfiguration** *(dict) --* The configuration information for a rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "contentBlockerRule", "contentRetrievalRule". * **contentBlockerRule** *(dict) --* A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **contentRetrievalRule** *(dict) --* Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. * **eligibleDataSources** *(list) --* Specifies data sources in a Amazon Q Business application to use for content generation. * *(dict) --* The identifier of the data source Amazon Q Business will generate responses from. * **indexId** *(string) --* The identifier of the index the data source is attached to. * **dataSourceId** *(string) --* The identifier of the data source. * **topicConfigurationsToDelete** (*list*) -- The configured topic specific chat controls you want to delete. * *(dict) --* The topic specific controls configured for an Amazon Q Business application. * **name** *(string) --* **[REQUIRED]** A name for your topic control configuration. * **description** *(string) --* A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. * **exampleChatMessages** *(list) --* A list of example phrases that you expect the end user to use in relation to the topic. * *(string) --* * **rules** *(list) --* **[REQUIRED]** Rules defined for a topic configuration. * *(dict) --* Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time. * **includedUsersAndGroups** *(dict) --* Users and groups to be included in a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **excludedUsersAndGroups** *(dict) --* Users and groups to be excluded from a rule. * **userIds** *(list) --* The user ids associated with a topic control rule. * *(string) --* * **userGroups** *(list) --* The user group names associated with a topic control rule. * *(string) --* * **ruleType** *(string) --* **[REQUIRED]** The type of rule. * **ruleConfiguration** *(dict) --* The configuration information for a rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "contentBlockerRule", "contentRetrievalRule". * **contentBlockerRule** *(dict) --* A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. * **systemMessageOverride** *(string) --* The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat. * **contentRetrievalRule** *(dict) --* Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. * **eligibleDataSources** *(list) --* Specifies data sources in a Amazon Q Business application to use for content generation. * *(dict) --* The identifier of the data source Amazon Q Business will generate responses from. * **indexId** *(string) --* The identifier of the index the data source is attached to. * **dataSourceId** *(string) --* The identifier of the data source. * **creatorModeConfiguration** (*dict*) -- The configuration details for "CREATOR_MODE". * **creatorModeControl** *(string) --* **[REQUIRED]** Status information about whether "CREATOR_MODE" has been enabled or disabled. The default status is "DISABLED". * **hallucinationReductionConfiguration** (*dict*) -- The hallucination reduction settings for your application. * **hallucinationReductionControl** *(string) --* Controls whether hallucination reduction has been enabled or disabled for your application. The default status is "DISABLED". Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / delete_retriever delete_retriever **************** QBusiness.Client.delete_retriever(**kwargs) Deletes the retriever used by an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.delete_retriever( applicationId='string', retrieverId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application using the retriever. * **retrieverId** (*string*) -- **[REQUIRED]** The identifier of the retriever being deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_group get_group ********* QBusiness.Client.get_group(**kwargs) Describes a group by group name. See also: AWS API Documentation **Request Syntax** response = client.get_group( applicationId='string', indexId='string', groupName='string', dataSourceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application id the group is attached to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index the group is attached to. * **groupName** (*string*) -- **[REQUIRED]** The name of the group. * **dataSourceId** (*string*) -- The identifier of the data source the group is attached to. Return type: dict Returns: **Response Syntax** { 'status': { 'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED', 'lastUpdatedAt': datetime(2015, 1, 1), 'errorDetail': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' } }, 'statusHistory': [ { 'status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED', 'lastUpdatedAt': datetime(2015, 1, 1), 'errorDetail': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' } }, ] } **Response Structure** * *(dict) --* * **status** *(dict) --* The current status of the group. * **status** *(string) --* The status of a group. * **lastUpdatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **errorDetail** *(dict) --* The details of an error associated a group status. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **statusHistory** *(list) --* The status history of the group. * *(dict) --* Provides the details of a group's status. * **status** *(string) --* The status of a group. * **lastUpdatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **errorDetail** *(dict) --* The details of an error associated a group status. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_messages list_messages ************* QBusiness.Client.list_messages(**kwargs) Gets a list of messages associated with an Amazon Q Business web experience. See also: AWS API Documentation **Request Syntax** response = client.list_messages( conversationId='string', applicationId='string', userId='string', nextToken='string', maxResults=123 ) Parameters: * **conversationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience conversation. * **applicationId** (*string*) -- **[REQUIRED]** The identifier for the Amazon Q Business application. * **userId** (*string*) -- The identifier of the user involved in the Amazon Q Business web experience conversation. * **nextToken** (*string*) -- If the number of messages returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages. * **maxResults** (*integer*) -- The maximum number of messages to return. Return type: dict Returns: **Response Syntax** { 'messages': [ { 'messageId': 'string', 'body': 'string', 'time': datetime(2015, 1, 1), 'type': 'USER'|'SYSTEM', 'attachments': [ { 'name': 'string', 'status': 'FAILED'|'SUCCESS', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'attachmentId': 'string', 'conversationId': 'string' }, ], 'sourceAttribution': [ { 'title': 'string', 'snippet': 'string', 'url': 'string', 'citationNumber': 123, 'updatedAt': datetime(2015, 1, 1), 'textMessageSegments': [ { 'beginOffset': 123, 'endOffset': 123, 'snippetExcerpt': { 'text': 'string' }, 'mediaId': 'string', 'mediaMimeType': 'string', 'sourceDetails': { 'imageSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string' }, 'audioSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'audioExtractionType': 'TRANSCRIPT'|'SUMMARY' }, 'videoSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'videoExtractionType': 'TRANSCRIPT'|'SUMMARY' } } }, ], 'documentId': 'string', 'indexId': 'string', 'datasourceId': 'string' }, ], 'actionReview': { 'pluginId': 'string', 'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'payload': { 'string': { 'displayName': 'string', 'displayOrder': 123, 'displayDescription': 'string', 'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN', 'value': {...}|[...]|123|123.4|'string'|True|None, 'allowedValues': [ { 'value': {...}|[...]|123|123.4|'string'|True|None, 'displayValue': {...}|[...]|123|123.4|'string'|True|None }, ], 'allowedFormat': 'string', 'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None, 'required': True|False } }, 'payloadFieldNameSeparator': 'string' }, 'actionExecution': { 'pluginId': 'string', 'payload': { 'string': { 'value': {...}|[...]|123|123.4|'string'|True|None } }, 'payloadFieldNameSeparator': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **messages** *(list) --* An array of information on one or more messages. * *(dict) --* A message in an Amazon Q Business web experience. * **messageId** *(string) --* The identifier of the Amazon Q Business web experience message. * **body** *(string) --* The content of the Amazon Q Business web experience message. * **time** *(datetime) --* The timestamp of the first Amazon Q Business web experience message. * **type** *(string) --* The type of Amazon Q Business message, whether "HUMAN" or "AI" generated. * **attachments** *(list) --* A file directly uploaded into an Amazon Q Business web experience chat. * *(dict) --* The details of a file uploaded during chat. * **name** *(string) --* The name of a file uploaded during chat. * **status** *(string) --* The status of a file uploaded during chat. * **error** *(dict) --* An error associated with a file uploaded during chat. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **attachmentId** *(string) --* The unique identifier of the Amazon Q Business attachment. * **conversationId** *(string) --* The unique identifier of the Amazon Q Business conversation. * **sourceAttribution** *(list) --* The source documents used to generate Amazon Q Business web experience message. * *(dict) --* The documents used to generate an Amazon Q Business web experience response. * **title** *(string) --* The title of the document which is the source for the Amazon Q Business generated response. * **snippet** *(string) --* The content extract from the document on which the generated response is based. * **url** *(string) --* The URL of the document which is the source for the Amazon Q Business generated response. * **citationNumber** *(integer) --* The number attached to a citation in an Amazon Q Business generated response. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **textMessageSegments** *(list) --* A text extract from a source document that is used for source attribution. * *(dict) --* Provides information about a text extract in a chat response that can be attributed to a source document. * **beginOffset** *(integer) --* The zero-based location in the response string where the source attribution starts. * **endOffset** *(integer) --* The zero-based location in the response string where the source attribution ends. * **snippetExcerpt** *(dict) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response. * **text** *(string) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response. * **mediaId** *(string) --* The identifier of the media object associated with the text segment in the source attribution. * **mediaMimeType** *(string) --* The MIME type (image/png) of the media object associated with the text segment in the source attribution. * **sourceDetails** *(dict) --* Source information for a segment of extracted text, including its media type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "imageSourceDetails", "audioSourceDetails", "videoSourceDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **imageSourceDetails** *(dict) --* Details specific to image content within the source. * **mediaId** *(string) --* Unique identifier for the image file. * **mediaMimeType** *(string) --* The MIME type of the image file. * **audioSourceDetails** *(dict) --* Details specific to audio content within the source. * **mediaId** *(string) --* Unique identifier for the audio media file. * **mediaMimeType** *(string) --* The MIME type of the audio file (e.g., audio/mp3, audio/wav). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant audio segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant audio segment. * **audioExtractionType** *(string) --* The type of audio extraction performed on the content. * **videoSourceDetails** *(dict) --* Details specific to video content within the source. * **mediaId** *(string) --* Unique identifier for the video media file. * **mediaMimeType** *(string) --* The MIME type of the video file (e.g., video/mp4, video/avi). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant video segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant video segment. * **videoExtractionType** *(string) --* The type of video extraction performed on the content. * **documentId** *(string) --* The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the "GetDocumentContent" API to retrieve the actual document content for user verification. * **indexId** *(string) --* The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored. * **datasourceId** *(string) --* The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid". * **actionReview** *(dict) --* An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non- streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business. * **pluginId** *(string) --* The identifier of the plugin associated with the action review. * **pluginType** *(string) --* The type of plugin. * **payload** *(dict) --* Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action review payload. * **displayName** *(string) --* The name of the field. * **displayOrder** *(integer) --* The display order of fields in a payload. * **displayDescription** *(string) --* The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field. * **type** *(string) --* The type of field. * **value** (*document*) -- The field value. * **allowedValues** *(list) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(dict) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * **value** (*document*) -- The field value. * **displayValue** (*document*) -- The name of the field. * **allowedFormat** *(string) --* The expected data format for the action review input field value. For example, in PTO request, "from" and "to" would be of "datetime" allowed format. * **arrayItemJsonSchema** (*document*) -- Use to create a custom form with array fields (fields with nested objects inside an array). * **required** *(boolean) --* Information about whether the field is required. * **payloadFieldNameSeparator** *(string) --* A string used to retain information about the hierarchical contexts within an action review payload. * **actionExecution** *(dict) --* Performs an Amazon Q Business plugin action during a non-streaming chat conversation. * **pluginId** *(string) --* The identifier of the plugin the action is attached to. * **payload** *(dict) --* A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action execution payload. * **value** (*document*) -- The content of a user input field in an plugin action execution payload. * **payloadFieldNameSeparator** *(string) --* A string used to retain information about the hierarchical contexts within an action execution event payload. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_index get_index ********* QBusiness.Client.get_index(**kwargs) Gets information about an existing Amazon Q Business index. See also: AWS API Documentation **Request Syntax** response = client.get_index( applicationId='string', indexId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the index. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business index you want information on. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'indexId': 'string', 'displayName': 'string', 'indexArn': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'type': 'ENTERPRISE'|'STARTER', 'description': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'capacityConfiguration': { 'units': 123 }, 'documentAttributeConfigurations': [ { 'name': 'string', 'type': 'STRING'|'STRING_LIST'|'NUMBER'|'DATE', 'search': 'ENABLED'|'DISABLED' }, ], 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'indexStatistics': { 'textDocumentStatistics': { 'indexedTextBytes': 123, 'indexedTextDocumentCount': 123 } } } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the Amazon Q Business application associated with the index. * **indexId** *(string) --* The identifier of the Amazon Q Business index. * **displayName** *(string) --* The name of the Amazon Q Business index. * **indexArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business index. * **status** *(string) --* The current status of the index. When the value is "ACTIVE", the index is ready for use. If the "Status" field value is "FAILED", the "ErrorMessage" field contains a message that explains why. * **type** *(string) --* The type of index attached to your Amazon Q Business application. * **description** *(string) --* The description for the Amazon Q Business index. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business index was created. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business index was last updated. * **capacityConfiguration** *(dict) --* The storage capacity units chosen for your Amazon Q Business index. * **units** *(integer) --* The number of storage units configured for an Amazon Q Business index. * **documentAttributeConfigurations** *(list) --* Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes. * *(dict) --* Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes. * **name** *(string) --* The name of the document attribute. * **type** *(string) --* The type of document attribute. * **search** *(string) --* Information about whether the document attribute can be used by an end user to search for information on their web experience. * **error** *(dict) --* When the "Status" field value is "FAILED", the "ErrorMessage" field contains a message that explains why. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **indexStatistics** *(dict) --* Provides information about the number of documents indexed. * **textDocumentStatistics** *(dict) --* The number of documents indexed. * **indexedTextBytes** *(integer) --* The total size, in bytes, of the indexed documents. * **indexedTextDocumentCount** *(integer) --* The number of text documents indexed. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_application update_application ****************** QBusiness.Client.update_application(**kwargs) Updates an existing Amazon Q Business application. Note: Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. Note: An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when "QAppsConfiguration" is enabled in the request. For more information, see Using service-linked roles for Q Apps. See also: AWS API Documentation **Request Syntax** response = client.update_application( applicationId='string', identityCenterInstanceArn='string', displayName='string', description='string', roleArn='string', attachmentsConfiguration={ 'attachmentsControlMode': 'ENABLED'|'DISABLED' }, qAppsConfiguration={ 'qAppsControlMode': 'ENABLED'|'DISABLED' }, personalizationConfiguration={ 'personalizationControlMode': 'ENABLED'|'DISABLED' }, autoSubscriptionConfiguration={ 'autoSubscribe': 'ENABLED'|'DISABLED', 'defaultSubscriptionType': 'Q_LITE'|'Q_BUSINESS' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **identityCenterInstanceArn** (*string*) -- The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. * **displayName** (*string*) -- A name for the Amazon Q Business application. * **description** (*string*) -- A description for the Amazon Q Business application. * **roleArn** (*string*) -- An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics. * **attachmentsConfiguration** (*dict*) -- An option to allow end users to upload files directly during chat. * **attachmentsControlMode** *(string) --* **[REQUIRED]** Status information about whether file upload functionality is activated or deactivated for your end user. * **qAppsConfiguration** (*dict*) -- An option to allow end users to create and use Amazon Q Apps in the web experience. * **qAppsControlMode** *(string) --* **[REQUIRED]** Status information about whether end users can create and use Amazon Q Apps in the web experience. * **personalizationConfiguration** (*dict*) -- Configuration information about chat response personalization. For more information, see Personalizing chat responses. * **personalizationControlMode** *(string) --* **[REQUIRED]** An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance. * **autoSubscriptionConfiguration** (*dict*) -- An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. * **autoSubscribe** *(string) --* **[REQUIRED]** Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management. * **defaultSubscriptionType** *(string) --* Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for "autoSubscribe" is set to "ENABLED" you must select a value for this field. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_web_experience create_web_experience ********************* QBusiness.Client.create_web_experience(**kwargs) Creates an Amazon Q Business web experience. See also: AWS API Documentation **Request Syntax** response = client.create_web_experience( applicationId='string', title='string', subtitle='string', welcomeMessage='string', samplePromptsControlMode='ENABLED'|'DISABLED', origins=[ 'string', ], roleArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ], clientToken='string', identityProviderConfiguration={ 'samlConfiguration': { 'authenticationUrl': 'string' }, 'openIDConnectConfiguration': { 'secretsArn': 'string', 'secretsRole': 'string' } }, browserExtensionConfiguration={ 'enabledBrowserExtensions': [ 'FIREFOX'|'CHROME', ] }, customizationConfiguration={ 'customCSSUrl': 'string', 'logoUrl': 'string', 'fontUrl': 'string', 'faviconUrl': 'string' } ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience. * **title** (*string*) -- The title for your Amazon Q Business web experience. * **subtitle** (*string*) -- A subtitle to personalize your Amazon Q Business web experience. * **welcomeMessage** (*string*) -- The customized welcome message for end users of an Amazon Q Business web experience. * **samplePromptsControlMode** (*string*) -- Determines whether sample prompts are enabled in the web experience for an end user. * **origins** (*list*) -- Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol ( "http/https"), the domain name, and the port number (if specified). Note: You must only submit a *base URL* and not a full path. For example, "https://docs.aws.amazon.com". * *(string) --* * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of the service role attached to your web experience. Note: You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value. * **tags** (*list*) -- A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. * **clientToken** (*string*) -- A token you provide to identify a request to create an Amazon Q Business web experience. This field is autopopulated if not provided. * **identityProviderConfiguration** (*dict*) -- Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "samlConfiguration", "openIDConnectConfiguration". * **samlConfiguration** *(dict) --* Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **authenticationUrl** *(string) --* **[REQUIRED]** The URL where Amazon Q Business end users will be redirected for authentication. * **openIDConnectConfiguration** *(dict) --* Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. * **secretsArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret. * **secretsRole** *(string) --* **[REQUIRED]** An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret. * **browserExtensionConfiguration** (*dict*) -- The browser extension configuration for an Amazon Q Business web experience. Note: For Amazon Q Business application using external OIDC- compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions.. * **enabledBrowserExtensions** *(list) --* **[REQUIRED]** Specify the browser extensions allowed for your Amazon Q web experience. * "CHROME" — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.). * "FIREFOX" — Enables the extension for Mozilla Firefox. * "CHROME" and "FIREFOX" — Enable the extension for Chromium-based browsers and Mozilla Firefox. * *(string) --* * **customizationConfiguration** (*dict*) -- Sets the custom logo, favicon, font, and color used in the Amazon Q web experience. * **customCSSUrl** *(string) --* Provides the URL where the custom CSS file is hosted for an Amazon Q web experience. * **logoUrl** *(string) --* Provides the URL where the custom logo file is hosted for an Amazon Q web experience. * **fontUrl** *(string) --* Provides the URL where the custom font file is hosted for an Amazon Q web experience. * **faviconUrl** *(string) --* Provides the URL where the custom favicon file is hosted for an Amazon Q web experience. Return type: dict Returns: **Response Syntax** { 'webExperienceId': 'string', 'webExperienceArn': 'string' } **Response Structure** * *(dict) --* * **webExperienceId** *(string) --* The identifier of the Amazon Q Business web experience. * **webExperienceArn** *(string) --* The Amazon Resource Name (ARN) of an Amazon Q Business web experience. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / create_index create_index ************ QBusiness.Client.create_index(**kwargs) Creates an Amazon Q Business index. To determine if index creation has completed, check the "Status" field returned from a call to "DescribeIndex". The "Status" field is set to "ACTIVE" when the index is ready to use. Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API. See also: AWS API Documentation **Request Syntax** response = client.create_index( applicationId='string', displayName='string', description='string', type='ENTERPRISE'|'STARTER', tags=[ { 'key': 'string', 'value': 'string' }, ], capacityConfiguration={ 'units': 123 }, clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application using the index. * **displayName** (*string*) -- **[REQUIRED]** A name for the Amazon Q Business index. * **description** (*string*) -- A description for the Amazon Q Business index. * **type** (*string*) -- The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers. * **tags** (*list*) -- A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. * **capacityConfiguration** (*dict*) -- The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs. * **units** *(integer) --* The number of storage units configured for an Amazon Q Business index. * **clientToken** (*string*) -- A token that you provide to identify the request to create an index. Multiple calls to the "CreateIndex" API with the same client token will create only one index. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'indexId': 'string', 'indexArn': 'string' } **Response Structure** * *(dict) --* * **indexId** *(string) --* The identifier for the Amazon Q Business index. * **indexArn** *(string) --* The Amazon Resource Name (ARN) of an Amazon Q Business index. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / chat_sync chat_sync ********* QBusiness.Client.chat_sync(**kwargs) Starts or continues a non-streaming Amazon Q Business conversation. See also: AWS API Documentation **Request Syntax** response = client.chat_sync( applicationId='string', userId='string', userGroups=[ 'string', ], userMessage='string', attachments=[ { 'data': b'bytes', 'name': 'string', 'copyFrom': { 'conversation': { 'conversationId': 'string', 'attachmentId': 'string' } } }, ], actionExecution={ 'pluginId': 'string', 'payload': { 'string': { 'value': {...}|[...]|123|123.4|'string'|True|None } }, 'payloadFieldNameSeparator': 'string' }, authChallengeResponse={ 'responseMap': { 'string': 'string' } }, conversationId='string', parentMessageId='string', attributeFilter={ 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } }, chatMode='RETRIEVAL_MODE'|'CREATOR_MODE'|'PLUGIN_MODE', chatModeConfiguration={ 'pluginConfiguration': { 'pluginId': 'string' } }, clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation. * **userId** (*string*) -- The identifier of the user attached to the chat input. * **userGroups** (*list*) -- The group names that a user associated with the chat input belongs to. * *(string) --* * **userMessage** (*string*) -- A end user message in a conversation. * **attachments** (*list*) -- A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each. * *(dict) --* This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat. * **data** *(bytes) --* The contents of the attachment. * **name** *(string) --* The filename of the attachment. * **copyFrom** *(dict) --* A reference to an existing attachment. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "conversation". * **conversation** *(dict) --* A reference to an attachment in an existing conversation. * **conversationId** *(string) --* **[REQUIRED]** The unique identifier of the Amazon Q Business conversation. * **attachmentId** *(string) --* **[REQUIRED]** The unique identifier of the Amazon Q Business attachment. * **actionExecution** (*dict*) -- A request from an end user to perform an Amazon Q Business plugin action. * **pluginId** *(string) --* **[REQUIRED]** The identifier of the plugin the action is attached to. * **payload** *(dict) --* **[REQUIRED]** A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action execution payload. * **value** (*document*) -- **[REQUIRED]** The content of a user input field in an plugin action execution payload. * **payloadFieldNameSeparator** *(string) --* **[REQUIRED]** A string used to retain information about the hierarchical contexts within an action execution event payload. * **authChallengeResponse** (*dict*) -- An authentication verification event response by a third party authentication server to Amazon Q Business. * **responseMap** *(dict) --* **[REQUIRED]** The mapping of key-value pairs in an authentication challenge response. * *(string) --* * *(string) --* * **conversationId** (*string*) -- The identifier of the Amazon Q Business conversation. * **parentMessageId** (*string*) -- The identifier of the previous system message in a conversation. * **attributeFilter** (*dict*) -- Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **chatMode** (*string*) -- The "chatMode" parameter determines the chat modes available to Amazon Q Business users: * "RETRIEVAL_MODE" - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "*No Answer Found*" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge * "CREATOR_MODE" - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge. * "PLUGIN_MODE" - By selecting this mode, users can choose to use plugins in chat to get their responses. Note: If none of the modes are selected, Amazon Q will only respond using the information from the attached files. For more information, see Admin controls and guardrails, Plugins, and Response sources. * **chatModeConfiguration** (*dict*) -- The chat mode configuration for an Amazon Q Business application. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "pluginConfiguration". * **pluginConfiguration** *(dict) --* Configuration information required to invoke chat in "PLUGIN_MODE". * **pluginId** *(string) --* **[REQUIRED]** The identifier of the plugin you want to use. * **clientToken** (*string*) -- A token that you provide to identify a chat request. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'conversationId': 'string', 'systemMessage': 'string', 'systemMessageId': 'string', 'userMessageId': 'string', 'actionReview': { 'pluginId': 'string', 'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'payload': { 'string': { 'displayName': 'string', 'displayOrder': 123, 'displayDescription': 'string', 'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN', 'value': {...}|[...]|123|123.4|'string'|True|None, 'allowedValues': [ { 'value': {...}|[...]|123|123.4|'string'|True|None, 'displayValue': {...}|[...]|123|123.4|'string'|True|None }, ], 'allowedFormat': 'string', 'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None, 'required': True|False } }, 'payloadFieldNameSeparator': 'string' }, 'authChallengeRequest': { 'authorizationUrl': 'string' }, 'sourceAttributions': [ { 'title': 'string', 'snippet': 'string', 'url': 'string', 'citationNumber': 123, 'updatedAt': datetime(2015, 1, 1), 'textMessageSegments': [ { 'beginOffset': 123, 'endOffset': 123, 'snippetExcerpt': { 'text': 'string' }, 'mediaId': 'string', 'mediaMimeType': 'string', 'sourceDetails': { 'imageSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string' }, 'audioSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'audioExtractionType': 'TRANSCRIPT'|'SUMMARY' }, 'videoSourceDetails': { 'mediaId': 'string', 'mediaMimeType': 'string', 'startTimeMilliseconds': 123, 'endTimeMilliseconds': 123, 'videoExtractionType': 'TRANSCRIPT'|'SUMMARY' } } }, ], 'documentId': 'string', 'indexId': 'string', 'datasourceId': 'string' }, ], 'failedAttachments': [ { 'name': 'string', 'status': 'FAILED'|'SUCCESS', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'attachmentId': 'string', 'conversationId': 'string' }, ] } **Response Structure** * *(dict) --* * **conversationId** *(string) --* The identifier of the Amazon Q Business conversation. * **systemMessage** *(string) --* An AI-generated message in a conversation. * **systemMessageId** *(string) --* The identifier of an Amazon Q Business AI generated message within the conversation. * **userMessageId** *(string) --* The identifier of an Amazon Q Business end user text input message within the conversation. * **actionReview** *(dict) --* A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action. * **pluginId** *(string) --* The identifier of the plugin associated with the action review. * **pluginType** *(string) --* The type of plugin. * **payload** *(dict) --* Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(string) --* * *(dict) --* A user input field in an plugin action review payload. * **displayName** *(string) --* The name of the field. * **displayOrder** *(integer) --* The display order of fields in a payload. * **displayDescription** *(string) --* The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field. * **type** *(string) --* The type of field. * **value** (*document*) -- The field value. * **allowedValues** *(list) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * *(dict) --* Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action. * **value** (*document*) -- The field value. * **displayValue** (*document*) -- The name of the field. * **allowedFormat** *(string) --* The expected data format for the action review input field value. For example, in PTO request, "from" and "to" would be of "datetime" allowed format. * **arrayItemJsonSchema** (*document*) -- Use to create a custom form with array fields (fields with nested objects inside an array). * **required** *(boolean) --* Information about whether the field is required. * **payloadFieldNameSeparator** *(string) --* A string used to retain information about the hierarchical contexts within an action review payload. * **authChallengeRequest** *(dict) --* An authentication verification event activated by an end user request to use a custom plugin. * **authorizationUrl** *(string) --* The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol. * **sourceAttributions** *(list) --* The source documents used to generate the conversation response. * *(dict) --* The documents used to generate an Amazon Q Business web experience response. * **title** *(string) --* The title of the document which is the source for the Amazon Q Business generated response. * **snippet** *(string) --* The content extract from the document on which the generated response is based. * **url** *(string) --* The URL of the document which is the source for the Amazon Q Business generated response. * **citationNumber** *(integer) --* The number attached to a citation in an Amazon Q Business generated response. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **textMessageSegments** *(list) --* A text extract from a source document that is used for source attribution. * *(dict) --* Provides information about a text extract in a chat response that can be attributed to a source document. * **beginOffset** *(integer) --* The zero-based location in the response string where the source attribution starts. * **endOffset** *(integer) --* The zero-based location in the response string where the source attribution ends. * **snippetExcerpt** *(dict) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response. * **text** *(string) --* The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response. * **mediaId** *(string) --* The identifier of the media object associated with the text segment in the source attribution. * **mediaMimeType** *(string) --* The MIME type (image/png) of the media object associated with the text segment in the source attribution. * **sourceDetails** *(dict) --* Source information for a segment of extracted text, including its media type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "imageSourceDetails", "audioSourceDetails", "videoSourceDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **imageSourceDetails** *(dict) --* Details specific to image content within the source. * **mediaId** *(string) --* Unique identifier for the image file. * **mediaMimeType** *(string) --* The MIME type of the image file. * **audioSourceDetails** *(dict) --* Details specific to audio content within the source. * **mediaId** *(string) --* Unique identifier for the audio media file. * **mediaMimeType** *(string) --* The MIME type of the audio file (e.g., audio/mp3, audio/wav). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant audio segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant audio segment. * **audioExtractionType** *(string) --* The type of audio extraction performed on the content. * **videoSourceDetails** *(dict) --* Details specific to video content within the source. * **mediaId** *(string) --* Unique identifier for the video media file. * **mediaMimeType** *(string) --* The MIME type of the video file (e.g., video/mp4, video/avi). * **startTimeMilliseconds** *(integer) --* The starting timestamp in milliseconds for the relevant video segment. * **endTimeMilliseconds** *(integer) --* The ending timestamp in milliseconds for the relevant video segment. * **videoExtractionType** *(string) --* The type of video extraction performed on the content. * **documentId** *(string) --* The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the "GetDocumentContent" API to retrieve the actual document content for user verification. * **indexId** *(string) --* The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored. * **datasourceId** *(string) --* The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat- datasourceid". * **failedAttachments** *(list) --* A list of files which failed to upload during chat. * *(dict) --* The details of a file uploaded during chat. * **name** *(string) --* The name of a file uploaded during chat. * **status** *(string) --* The status of a file uploaded during chat. * **error** *(dict) --* An error associated with a file uploaded during chat. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **attachmentId** *(string) --* The unique identifier of the Amazon Q Business attachment. * **conversationId** *(string) --* The unique identifier of the Amazon Q Business conversation. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ExternalResourceException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_subscription create_subscription ******************* QBusiness.Client.create_subscription(**kwargs) Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: "Q_LITE" and "Q_BUSINESS". Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. Note: For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide. See also: AWS API Documentation **Request Syntax** response = client.create_subscription( applicationId='string', principal={ 'user': 'string', 'group': 'string' }, type='Q_LITE'|'Q_BUSINESS', clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the subscription should be added to. * **principal** (*dict*) -- **[REQUIRED]** The IAM Identity Center "UserId" or "GroupId" of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "user", "group". * **user** *(string) --* The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application. * **group** *(string) --* The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application. * **type** (*string*) -- **[REQUIRED]** The type of Amazon Q Business subscription you want to create. * **clientToken** (*string*) -- A token that you provide to identify the request to create a subscription for your Amazon Q Business application. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'subscriptionId': 'string', 'subscriptionArn': 'string', 'currentSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' }, 'nextSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' } } **Response Structure** * *(dict) --* * **subscriptionId** *(string) --* The identifier of the Amazon Q Business subscription created. * **subscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business subscription created. * **currentSubscription** *(dict) --* The type of your current Amazon Q Business subscription. * **type** *(string) --* The type of an Amazon Q Business subscription. * **nextSubscription** *(dict) --* The type of the Amazon Q Business subscription for the next month. * **type** *(string) --* The type of an Amazon Q Business subscription. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_web_experience delete_web_experience ********************* QBusiness.Client.delete_web_experience(**kwargs) Deletes an Amazon Q Business web experience. See also: AWS API Documentation **Request Syntax** response = client.delete_web_experience( applicationId='string', webExperienceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience. * **webExperienceId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience being deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / close close ***** QBusiness.Client.close() Closes underlying endpoint connections. QBusiness / Client / cancel_subscription cancel_subscription ******************* QBusiness.Client.cancel_subscription(**kwargs) Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. See also: AWS API Documentation **Request Syntax** response = client.cancel_subscription( applicationId='string', subscriptionId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application for which the subscription is being cancelled. * **subscriptionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business subscription being cancelled. Return type: dict Returns: **Response Syntax** { 'subscriptionArn': 'string', 'currentSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' }, 'nextSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' } } **Response Structure** * *(dict) --* * **subscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled. * **currentSubscription** *(dict) --* The type of your current Amazon Q Business subscription. * **type** *(string) --* The type of an Amazon Q Business subscription. * **nextSubscription** *(dict) --* The type of the Amazon Q Business subscription for the next month. * **type** *(string) --* The type of an Amazon Q Business subscription. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_groups list_groups *********** QBusiness.Client.list_groups(**kwargs) Provides a list of groups that are mapped to users. See also: AWS API Documentation **Request Syntax** response = client.list_groups( applicationId='string', indexId='string', updatedEarlierThan=datetime(2015, 1, 1), dataSourceId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application for getting a list of groups mapped to users. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index for getting a list of groups mapped to users. * **updatedEarlierThan** (*datetime*) -- **[REQUIRED]** The timestamp identifier used for the latest "PUT" or "DELETE" action for mapping users to their groups. * **dataSourceId** (*string*) -- The identifier of the data source for getting a list of groups mapped to users. * **nextToken** (*string*) -- If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users. * **maxResults** (*integer*) -- The maximum number of returned groups that are mapped to users. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'items': [ { 'groupName': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users. * **items** *(list) --* Summary information for list of groups that are mapped to users. * *(dict) --* Summary information for groups. * **groupName** *(string) --* The name of the group the summary information is for. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_plugin_type_metadata list_plugin_type_metadata ************************* QBusiness.Client.list_plugin_type_metadata(**kwargs) Lists metadata for all Amazon Q Business plugin types. See also: AWS API Documentation **Request Syntax** response = client.list_plugin_type_metadata( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- If the metadata returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata. * **maxResults** (*integer*) -- The maximum number of plugin metadata items to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'items': [ { 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'category': 'Customer relationship management (CRM)'|'Project management'|'Communication'|'Productivity'|'Ticketing and incident management', 'description': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata. * **items** *(list) --* An array of information on plugin metadata. * *(dict) --* Summary metadata information for a Amazon Q Business plugin. * **type** *(string) --* The type of the plugin. * **category** *(string) --* The category of the plugin type. * **description** *(string) --* The description assigned by Amazon Q Business to a plugin. You can't modify this value. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_plugin get_plugin ********** QBusiness.Client.get_plugin(**kwargs) Gets information about an existing Amazon Q Business plugin. See also: AWS API Documentation **Request Syntax** response = client.get_plugin( applicationId='string', pluginId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application which contains the plugin. * **pluginId** (*string*) -- **[REQUIRED]** The identifier of the plugin. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'pluginId': 'string', 'displayName': 'string', 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA', 'serverUrl': 'string', 'authConfiguration': { 'basicAuthConfiguration': { 'secretArn': 'string', 'roleArn': 'string' }, 'oAuth2ClientCredentialConfiguration': { 'secretArn': 'string', 'roleArn': 'string', 'authorizationUrl': 'string', 'tokenUrl': 'string' }, 'noAuthConfiguration': {}, 'idcAuthConfiguration': { 'idcApplicationArn': 'string', 'roleArn': 'string' } }, 'customPluginConfiguration': { 'description': 'string', 'apiSchemaType': 'OPEN_API_V3', 'apiSchema': { 'payload': 'string', 's3': { 'bucket': 'string', 'key': 'string' } } }, 'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED', 'pluginArn': 'string', 'state': 'ENABLED'|'DISABLED', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the application which contains the plugin. * **pluginId** *(string) --* The identifier of the plugin. * **displayName** *(string) --* The name of the plugin. * **type** *(string) --* The type of the plugin. * **serverUrl** *(string) --* The source URL used for plugin configuration. * **authConfiguration** *(dict) --* Authentication configuration information for an Amazon Q Business plugin. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "basicAuthConfiguration", "oAuth2ClientCredentialConfiguration", "noAuthConfiguration", "idcAuthConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **basicAuthConfiguration** *(dict) --* Information about the basic authentication credentials used to configure a plugin. * **secretArn** *(string) --* The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration.. * **roleArn** *(string) --* The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. * **oAuth2ClientCredentialConfiguration** *(dict) --* Information about the OAuth 2.0 authentication credential/token used to configure a plugin. * **secretArn** *(string) --* The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration. * **roleArn** *(string) --* The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret. * **authorizationUrl** *(string) --* The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server. * **tokenUrl** *(string) --* The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token. * **noAuthConfiguration** *(dict) --* Information about invoking a custom plugin without any authentication. * **idcAuthConfiguration** *(dict) --* Information about the IAM Identity Center Application used to configure authentication for a plugin. * **idcApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf. * **customPluginConfiguration** *(dict) --* Configuration information required to create a custom plugin. * **description** *(string) --* A description for your custom plugin configuration. * **apiSchemaType** *(string) --* The type of OpenAPI schema to use. * **apiSchema** *(dict) --* Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML- formatted payload defining the schema. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "payload", "s3". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **payload** *(string) --* The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin. * **s3** *(dict) --* Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format. * **bucket** *(string) --* The name of the S3 bucket that contains the file. * **key** *(string) --* The name of the file. * **buildStatus** *(string) --* The current status of a plugin. A plugin is modified asynchronously. * **pluginArn** *(string) --* The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin. * **state** *(string) --* The current state of the plugin. * **createdAt** *(datetime) --* The timestamp for when the plugin was created. * **updatedAt** *(datetime) --* The timestamp for when the plugin was last updated. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_web_experiences list_web_experiences ******************** QBusiness.Client.list_web_experiences(**kwargs) Lists one or more Amazon Q Business Web Experiences. See also: AWS API Documentation **Request Syntax** response = client.list_web_experiences( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application linked to the listed web experiences. * **nextToken** (*string*) -- If the "maxResults" response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations. * **maxResults** (*integer*) -- The maximum number of Amazon Q Business Web Experiences to return. Return type: dict Returns: **Response Syntax** { 'webExperiences': [ { 'webExperienceId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'defaultEndpoint': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **webExperiences** *(list) --* An array of summary information for one or more Amazon Q Business experiences. * *(dict) --* Provides information for an Amazon Q Business web experience. * **webExperienceId** *(string) --* The identifier of your Amazon Q Business web experience. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **updatedAt** *(datetime) --* The Unix timestamp when your Amazon Q Business web experience was updated. * **defaultEndpoint** *(string) --* The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services. * **status** *(string) --* The status of your Amazon Q Business web experience. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_plugin_actions list_plugin_actions ******************* QBusiness.Client.list_plugin_actions(**kwargs) Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.list_plugin_actions( applicationId='string', pluginId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application the plugin is attached to. * **pluginId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business plugin. * **nextToken** (*string*) -- If the number of plugin actions returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions. * **maxResults** (*integer*) -- The maximum number of plugin actions to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'items': [ { 'actionIdentifier': 'string', 'displayName': 'string', 'instructionExample': 'string', 'description': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions. * **items** *(list) --* An array of information on one or more plugin actions. * *(dict) --* Summary information for an Amazon Q Business plugin action. * **actionIdentifier** *(string) --* The identifier of an Amazon Q Business plugin action. * **displayName** *(string) --* The display name assigned by Amazon Q Business to a plugin action. You can't modify this value. * **instructionExample** *(string) --* An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example: * Create a Jira task * Create a chat assistant task to find the root cause of a specific incident * **description** *(string) --* The description of an Amazon Q Business plugin action. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / batch_delete_document batch_delete_document ********************* QBusiness.Client.batch_delete_document(**kwargs) Asynchronously deletes one or more documents added using the "BatchPutDocument" API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch. See also: AWS API Documentation **Request Syntax** response = client.batch_delete_document( applicationId='string', indexId='string', documents=[ { 'documentId': 'string' }, ], dataSourceSyncId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business index that contains the documents to delete. * **documents** (*list*) -- **[REQUIRED]** Documents deleted from the Amazon Q Business index. * *(dict) --* A document deleted from an Amazon Q Business data source connector. * **documentId** *(string) --* **[REQUIRED]** The identifier of the deleted document. * **dataSourceSyncId** (*string*) -- The identifier of the data source sync during which the documents were deleted. Return type: dict Returns: **Response Syntax** { 'failedDocuments': [ { 'id': 'string', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'dataSourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **failedDocuments** *(list) --* A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index. * *(dict) --* A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index. * **id** *(string) --* The identifier of the document that couldn't be removed from the Amazon Q Business index. * **error** *(dict) --* An explanation for why the document couldn't be removed from the index. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **dataSourceId** *(string) --* The identifier of the Amazon Q Business data source connector that contains the failed document. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / put_group put_group ********* QBusiness.Client.put_group(**kwargs) Create, or updates, a mapping of users—who have access to a document—to groups. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results. There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a "RoleArn" for Amazon Q Buisness to access the file. See also: AWS API Documentation **Request Syntax** response = client.put_group( applicationId='string', indexId='string', groupName='string', dataSourceId='string', type='INDEX'|'DATASOURCE', groupMembers={ 'memberGroups': [ { 'groupName': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 'memberUsers': [ { 'userId': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 's3PathForGroupMembers': { 'bucket': 'string', 'key': 'string' } }, roleArn='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the application in which the user and group mapping belongs. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index in which you want to map users to their groups. * **groupName** (*string*) -- **[REQUIRED]** The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing". * **dataSourceId** (*string*) -- The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer- related documents stored in Salesforce. * **type** (*string*) -- **[REQUIRED]** The type of the group. * **groupMembers** (*dict*) -- **[REQUIRED]** A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to. * **memberGroups** *(list) --* A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company". * *(dict) --* The sub groups that belong to a group. * **groupName** *(string) --* **[REQUIRED]** The name of the sub group. * **type** *(string) --* The type of the sub group. * **memberUsers** *(list) --* A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group. * *(dict) --* The users that belong to a group. * **userId** *(string) --* **[REQUIRED]** The identifier of the user you want to map to a group. * **type** *(string) --* The type of the user. * **s3PathForGroupMembers** *(dict) --* Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket. * **bucket** *(string) --* **[REQUIRED]** The name of the S3 bucket that contains the file. * **key** *(string) --* **[REQUIRED]** The name of the file. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / list_indices list_indices ************ QBusiness.Client.list_indices(**kwargs) Lists the Amazon Q Business indices you have created. See also: AWS API Documentation **Request Syntax** response = client.list_indices( applicationId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the index. * **nextToken** (*string*) -- If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices. * **maxResults** (*integer*) -- The maximum number of indices to return. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'indices': [ { 'displayName': 'string', 'indexId': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes. * **indices** *(list) --* An array of information on the items in one or more indexes. * *(dict) --* Summary information for your Amazon Q Business index. * **displayName** *(string) --* The name of the index. * **indexId** *(string) --* The identifier for the index. * **createdAt** *(datetime) --* The Unix timestamp when the index was created. * **updatedAt** *(datetime) --* The Unix timestamp when the index was last updated. * **status** *(string) --* The current status of the index. When the status is "ACTIVE", the index is ready. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / update_index update_index ************ QBusiness.Client.update_index(**kwargs) Updates an Amazon Q Business index. See also: AWS API Documentation **Request Syntax** response = client.update_index( applicationId='string', indexId='string', displayName='string', description='string', capacityConfiguration={ 'units': 123 }, documentAttributeConfigurations=[ { 'name': 'string', 'type': 'STRING'|'STRING_LIST'|'NUMBER'|'DATE', 'search': 'ENABLED'|'DISABLED' }, ] ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application connected to the index. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business index. * **displayName** (*string*) -- The name of the Amazon Q Business index. * **description** (*string*) -- The description of the Amazon Q Business index. * **capacityConfiguration** (*dict*) -- The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs. * **units** *(integer) --* The number of storage units configured for an Amazon Q Business index. * **documentAttributeConfigurations** (*list*) -- Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes. * *(dict) --* Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes. * **name** *(string) --* The name of the document attribute. * **type** *(string) --* The type of document attribute. * **search** *(string) --* Information about whether the document attribute can be used by an end user to search for information on their web experience. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / delete_conversation delete_conversation ******************* QBusiness.Client.delete_conversation(**kwargs) Deletes an Amazon Q Business web experience conversation. See also: AWS API Documentation **Request Syntax** response = client.delete_conversation( conversationId='string', applicationId='string', userId='string' ) Parameters: * **conversationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business web experience conversation being deleted. * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application associated with the conversation. * **userId** (*string*) -- The identifier of the user who is deleting the conversation. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / delete_application delete_application ****************** QBusiness.Client.delete_application(**kwargs) Deletes an Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.delete_application( applicationId='string' ) Parameters: **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_policy get_policy ********** QBusiness.Client.get_policy(**kwargs) Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources. See also: AWS API Documentation **Request Syntax** response = client.get_policy( applicationId='string' ) Parameters: **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. Return type: dict Returns: **Response Syntax** { 'policy': 'string' } **Response Structure** * *(dict) --* * **policy** *(string) --* The JSON representation of the permission policy. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_application create_application ****************** QBusiness.Client.create_application(**kwargs) Creates an Amazon Q Business application. Note: There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when "QAppsConfiguration" is enabled in the request. For more information, see Using service-linked roles for Q Apps.When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business. See also: AWS API Documentation **Request Syntax** response = client.create_application( displayName='string', roleArn='string', identityType='AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS', iamIdentityProviderArn='string', identityCenterInstanceArn='string', clientIdsForOIDC=[ 'string', ], description='string', encryptionConfiguration={ 'kmsKeyId': 'string' }, tags=[ { 'key': 'string', 'value': 'string' }, ], clientToken='string', attachmentsConfiguration={ 'attachmentsControlMode': 'ENABLED'|'DISABLED' }, qAppsConfiguration={ 'qAppsControlMode': 'ENABLED'|'DISABLED' }, personalizationConfiguration={ 'personalizationControlMode': 'ENABLED'|'DISABLED' }, quickSightConfiguration={ 'clientNamespace': 'string' } ) Parameters: * **displayName** (*string*) -- **[REQUIRED]** A name for the Amazon Q Business application. * **roleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role. * **identityType** (*string*) -- The authentication type being used by a Amazon Q Business application. * **iamIdentityProviderArn** (*string*) -- The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application. * **identityCenterInstanceArn** (*string*) -- The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. * **clientIdsForOIDC** (*list*) -- The OIDC client ID for a Amazon Q Business application. * *(string) --* * **description** (*string*) -- A description for the Amazon Q Business application. * **encryptionConfiguration** (*dict*) -- The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys. * **kmsKeyId** *(string) --* The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys. * **tags** (*list*) -- A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. * **clientToken** (*string*) -- A token that you provide to identify the request to create your Amazon Q Business application. This field is autopopulated if not provided. * **attachmentsConfiguration** (*dict*) -- An option to allow end users to upload files directly during chat. * **attachmentsControlMode** *(string) --* **[REQUIRED]** Status information about whether file upload functionality is activated or deactivated for your end user. * **qAppsConfiguration** (*dict*) -- An option to allow end users to create and use Amazon Q Apps in the web experience. * **qAppsControlMode** *(string) --* **[REQUIRED]** Status information about whether end users can create and use Amazon Q Apps in the web experience. * **personalizationConfiguration** (*dict*) -- Configuration information about chat response personalization. For more information, see Personalizing chat responses * **personalizationControlMode** *(string) --* **[REQUIRED]** An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance. * **quickSightConfiguration** (*dict*) -- The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application. * **clientNamespace** *(string) --* **[REQUIRED]** The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations. Return type: dict Returns: **Response Syntax** { 'applicationId': 'string', 'applicationArn': 'string' } **Response Structure** * *(dict) --* * **applicationId** *(string) --* The identifier of the Amazon Q Business application. * **applicationArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business application. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / update_chat_response_configuration update_chat_response_configuration ********************************** QBusiness.Client.update_chat_response_configuration(**kwargs) Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses. See also: AWS API Documentation **Request Syntax** response = client.update_chat_response_configuration( applicationId='string', chatResponseConfigurationId='string', displayName='string', responseConfigurations={ 'string': { 'instructionCollection': { 'responseLength': 'string', 'targetAudience': 'string', 'perspective': 'string', 'outputStyle': 'string', 'identity': 'string', 'tone': 'string', 'customInstructions': 'string', 'examples': 'string' } } }, clientToken='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application containing the chat response configuration to update. * **chatResponseConfigurationId** (*string*) -- **[REQUIRED]** The unique identifier of the chat response configuration to update within the specified application. * **displayName** (*string*) -- The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations. * **responseConfigurations** (*dict*) -- **[REQUIRED]** The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries. * *(string) --* * *(dict) --* Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics. * **instructionCollection** *(dict) --* A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions. * **responseLength** *(string) --* Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive. * **targetAudience** *(string) --* Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge. * **perspective** *(string) --* Determines the point of view or perspective from which Amazon Q Business generates responses, such as first- person, second-person, or third-person perspective, affecting how information is presented to users. * **outputStyle** *(string) --* Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by- step instructions, or other organizational formats that enhance readability and comprehension. * **identity** *(string) --* Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization. * **tone** *(string) --* Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations. * **customInstructions** *(string) --* Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation. * **examples** *(string) --* Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / tag_resource tag_resource ************ QBusiness.Client.tag_resource(**kwargs) Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceARN='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag. * **tags** (*list*) -- **[REQUIRED]** A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_retriever create_retriever **************** QBusiness.Client.create_retriever(**kwargs) Adds a retriever to your Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.create_retriever( applicationId='string', type='NATIVE_INDEX'|'KENDRA_INDEX', displayName='string', configuration={ 'nativeIndexConfiguration': { 'indexId': 'string', 'version': 123, 'boostingOverride': { 'string': { 'numberConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingType': 'PRIORITIZE_LARGER_VALUES'|'PRIORITIZE_SMALLER_VALUES' }, 'stringConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'attributeValueBoosting': { 'string': 'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO'|'THREE'|'FOUR'|'FIVE' } }, 'dateConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO', 'boostingDurationInSeconds': 123 }, 'stringListConfiguration': { 'boostingLevel': 'NONE'|'LOW'|'MEDIUM'|'HIGH'|'VERY_HIGH'|'ONE'|'TWO' } } } }, 'kendraIndexConfiguration': { 'indexId': 'string' } }, roleArn='string', clientToken='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of your Amazon Q Business application. * **type** (*string*) -- **[REQUIRED]** The type of retriever you are using. * **displayName** (*string*) -- **[REQUIRED]** The name of your retriever. * **configuration** (*dict*) -- **[REQUIRED]** Provides information on how the retriever used for your Amazon Q Business application is configured. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "nativeIndexConfiguration", "kendraIndexConfiguration". * **nativeIndexConfiguration** *(dict) --* Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* **[REQUIRED]** The identifier for the Amazon Q Business index. * **version** *(integer) --* A read-only field that specifies the version of the "NativeIndexConfiguration". Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of "NativeIndexConfiguration", focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1: * Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting * Version 2 supports a single String field with an ordered list of up to 5 values * Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels * Version 2 allows specifying prioritization between Date and String fields * Version 2 maintains backward compatibility with existing configurations * **boostingOverride** *(dict) --* Overrides the default boosts applied by Amazon Q Business to supported document attribute data types. * *(string) --* * *(dict) --* Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes. In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results. Note: For "STRING" and "STRING_LIST" type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API. For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "numberConfiguration", "stringConfiguration", "dateConfiguration", "stringListConfiguration". * **numberConfiguration** *(dict) --* Provides information on boosting "NUMBER" type document attributes. "NUMBER" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "NUMBER" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **boostingType** *(string) --* Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important). * **stringConfiguration** *(dict) --* Provides information on boosting "STRING" type document attributes. Version 2 assigns priority tiers to "STRING" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **attributeValueBoosting** *(dict) --* Specifies specific values of a "STRING" type document attribute being boosted. When using "NativeIndexConfiguration" version 2, you can specify up to five values in order of priority. * *(string) --* * *(string) --* * **dateConfiguration** *(dict) --* Provides information on boosting "DATE" type document attributes. Version 2 assigns priority tiers to "DATE" attributes, establishing clear hierarchical relationships with other boosted attributes. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO. * **boostingDurationInSeconds** *(integer) --* Specifies the duration, in seconds, of a boost applies to a "DATE" type document attribute. * **stringListConfiguration** *(dict) --* Provides information on boosting "STRING_LIST" type document attributes. "STRING_LIST" attributes are not supported when using "NativeIndexConfiguration" version 2, which focuses on "DATE" attributes for recency and "STRING" attributes for source prioritization. * **boostingLevel** *(string) --* **[REQUIRED]** Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. "STRING_LIST" attributes can serve as additional boosting factors when needed, but are not supported when using "NativeIndexConfiguration" version 2. * **kendraIndexConfiguration** *(dict) --* Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured. * **indexId** *(string) --* **[REQUIRED]** The identifier of the Amazon Kendra index. * **roleArn** (*string*) -- The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. * **clientToken** (*string*) -- A token that you provide to identify the request to create your Amazon Q Business application retriever. This field is autopopulated if not provided. * **tags** (*list*) -- A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. Return type: dict Returns: **Response Syntax** { 'retrieverId': 'string', 'retrieverArn': 'string' } **Response Structure** * *(dict) --* * **retrieverId** *(string) --* The identifier of the retriever you are using. * **retrieverArn** *(string) --* The Amazon Resource Name (ARN) of an IAM role associated with a retriever. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / update_subscription update_subscription ******************* QBusiness.Client.update_subscription(**kwargs) Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. See also: AWS API Documentation **Request Syntax** response = client.update_subscription( applicationId='string', subscriptionId='string', type='Q_LITE'|'Q_BUSINESS' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application where the subscription update should take effect. * **subscriptionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business subscription to be updated. * **type** (*string*) -- **[REQUIRED]** The type of the Amazon Q Business subscription to be updated. Return type: dict Returns: **Response Syntax** { 'subscriptionArn': 'string', 'currentSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' }, 'nextSubscription': { 'type': 'Q_LITE'|'Q_BUSINESS' } } **Response Structure** * *(dict) --* * **subscriptionArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated. * **currentSubscription** *(dict) --* The type of your current Amazon Q Business subscription. * **type** *(string) --* The type of an Amazon Q Business subscription. * **nextSubscription** *(dict) --* The type of the Amazon Q Business subscription for the next month. * **type** *(string) --* The type of an Amazon Q Business subscription. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / list_attachments list_attachments **************** QBusiness.Client.list_attachments(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_attachments( applicationId='string', conversationId='string', userId='string', nextToken='string', maxResults=123 ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier for the Amazon Q Business application. * **conversationId** (*string*) -- The unique identifier of the Amazon Q Business web experience conversation. * **userId** (*string*) -- The unique identifier of the user involved in the Amazon Q Business web experience conversation. * **nextToken** (*string*) -- If the number of attachments returned exceeds "maxResults", Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments. * **maxResults** (*integer*) -- The maximum number of attachements to return. Return type: dict Returns: **Response Syntax** { 'attachments': [ { 'attachmentId': 'string', 'conversationId': 'string', 'name': 'string', 'copyFrom': { 'conversation': { 'conversationId': 'string', 'attachmentId': 'string' } }, 'fileType': 'string', 'fileSize': 123, 'md5chksum': 'string', 'createdAt': datetime(2015, 1, 1), 'status': 'FAILED'|'SUCCESS', 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **attachments** *(list) --* An array of information on one or more attachments. * *(dict) --* An attachment in an Amazon Q Business conversation. * **attachmentId** *(string) --* The identifier of the Amazon Q Business attachment. * **conversationId** *(string) --* The identifier of the Amazon Q Business conversation the attachment is associated with. * **name** *(string) --* Filename of the Amazon Q Business attachment. * **copyFrom** *(dict) --* A CopyFromSource containing a reference to the original source of the Amazon Q Business attachment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "conversation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **conversation** *(dict) --* A reference to an attachment in an existing conversation. * **conversationId** *(string) --* The unique identifier of the Amazon Q Business conversation. * **attachmentId** *(string) --* The unique identifier of the Amazon Q Business attachment. * **fileType** *(string) --* Filetype of the Amazon Q Business attachment. * **fileSize** *(integer) --* Size in bytes of the Amazon Q Business attachment. * **md5chksum** *(string) --* MD5 checksum of the Amazon Q Business attachment contents. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business attachment was created. * **status** *(string) --* AttachmentStatus of the Amazon Q Business attachment. * **error** *(dict) --* ErrorDetail providing information about a Amazon Q Business attachment error. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **nextToken** *(string) --* If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.LicenseNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / create_data_accessor create_data_accessor ******************** QBusiness.Client.create_data_accessor(**kwargs) Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.create_data_accessor( applicationId='string', principal='string', actionConfigurations=[ { 'action': 'string', 'filterConfiguration': { 'documentAttributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } } }, ], clientToken='string', displayName='string', authenticationDetail={ 'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE', 'authenticationConfiguration': { 'idcTrustedTokenIssuerConfiguration': { 'idcTrustedTokenIssuerArn': 'string' } }, 'externalIds': [ 'string', ] }, tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application. * **principal** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data. * **actionConfigurations** (*list*) -- **[REQUIRED]** A list of action configurations specifying the allowed actions and any associated filters. * *(dict) --* Specifies an allowed action and its associated filter configuration. * **action** *(string) --* **[REQUIRED]** The Amazon Q Business action that is allowed. * **filterConfiguration** *(dict) --* The filter configuration for the action, if any. * **documentAttributeFilter** *(dict) --* **[REQUIRED]** Enables filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* Enables filtering of responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **clientToken** (*string*) -- A unique, case-sensitive identifier you provide to ensure idempotency of the request. This field is autopopulated if not provided. * **displayName** (*string*) -- **[REQUIRED]** A friendly name for the data accessor. * **authenticationDetail** (*dict*) -- The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor. * **authenticationType** *(string) --* **[REQUIRED]** The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types: * "AWS_IAM_IDC_TTI" - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data. * "AWS_IAM_IDC_AUTH_CODE" - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication. * **authenticationConfiguration** *(dict) --* The specific authentication configuration based on the authentication type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "idcTrustedTokenIssuerConfiguration". * **idcTrustedTokenIssuerConfiguration** *(dict) --* Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is "AWS_IAM_IDC_TTI". * **idcTrustedTokenIssuerArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication. * **externalIds** *(list) --* A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems. * *(string) --* * **tags** (*list*) -- The tags to associate with the data accessor. * *(dict) --* A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. * **key** *(string) --* **[REQUIRED]** The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source. * **value** *(string) --* **[REQUIRED]** The value associated with the tag. The value may be an empty string but it can't be null. Return type: dict Returns: **Response Syntax** { 'dataAccessorId': 'string', 'idcApplicationArn': 'string', 'dataAccessorArn': 'string' } **Response Structure** * *(dict) --* * **dataAccessorId** *(string) --* The unique identifier of the created data accessor. * **idcApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor. * **dataAccessorArn** *(string) --* The Amazon Resource Name (ARN) of the created data accessor. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" * "QBusiness.Client.exceptions.ServiceQuotaExceededException" QBusiness / Client / stop_data_source_sync_job stop_data_source_sync_job ************************* QBusiness.Client.stop_data_source_sync_job(**kwargs) Stops an Amazon Q Business data source connector synchronization job already in progress. See also: AWS API Documentation **Request Syntax** response = client.stop_data_source_sync_job( dataSourceId='string', applicationId='string', indexId='string' ) Parameters: * **dataSourceId** (*string*) -- **[REQUIRED]** The identifier of the data source connector. * **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application that the data source is connected to. * **indexId** (*string*) -- **[REQUIRED]** The identifier of the index used with the Amazon Q Business data source connector. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ConflictException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / check_document_access check_document_access ********************* QBusiness.Client.check_document_access(**kwargs) Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access. See also: AWS API Documentation **Request Syntax** response = client.check_document_access( applicationId='string', indexId='string', userId='string', documentId='string', dataSourceId='string' ) Parameters: * **applicationId** (*string*) -- **[REQUIRED]** The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check. * **indexId** (*string*) -- **[REQUIRED]** The unique identifier of the index. Used to locate the correct index within the application where the document is stored. * **userId** (*string*) -- **[REQUIRED]** The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL. * **documentId** (*string*) -- **[REQUIRED]** The unique identifier of the document. Specifies which document's access permissions are being checked. * **dataSourceId** (*string*) -- The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary. Return type: dict Returns: **Response Syntax** { 'userGroups': [ { 'name': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 'userAliases': [ { 'id': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 'hasAccess': True|False, 'documentAcl': { 'allowlist': { 'memberRelation': 'AND'|'OR', 'conditions': [ { 'memberRelation': 'AND'|'OR', 'users': [ { 'id': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 'groups': [ { 'name': 'string', 'type': 'INDEX'|'DATASOURCE' }, ] }, ] }, 'denyList': { 'memberRelation': 'AND'|'OR', 'conditions': [ { 'memberRelation': 'AND'|'OR', 'users': [ { 'id': 'string', 'type': 'INDEX'|'DATASOURCE' }, ], 'groups': [ { 'name': 'string', 'type': 'INDEX'|'DATASOURCE' }, ] }, ] } } } **Response Structure** * *(dict) --* * **userGroups** *(list) --* An array of groups the user is part of for the specified data source. Each group has a name and type. * *(dict) --* Represents a group associated with a given user in the access control system. * **name** *(string) --* The name of the group associated with the user. This is used to identify the group in access control decisions. * **type** *(string) --* The type of the associated group. This indicates the scope of the group's applicability. * **userAliases** *(list) --* An array of aliases associated with the user. This includes both global and local aliases, each with a name and type. * *(dict) --* Represents an associated user in the access control system. * **id** *(string) --* The unique identifier of the associated user. This is used to identify the user in access control decisions. * **type** *(string) --* The type of the associated user. This indicates the scope of the user's association. * **hasAccess** *(boolean) --* A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document. * **documentAcl** *(dict) --* The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access. * **allowlist** *(dict) --* The allowlist conditions for the document. Users or groups matching these conditions are granted access to the document. * **memberRelation** *(string) --* The logical relation between members in the membership rule, determining how multiple conditions are combined. * **conditions** *(list) --* An array of conditions that define the membership rules. Each condition specifies criteria for users or groups to be included in this membership. * *(dict) --* Represents a condition in the document's ACL, specifying access rules for users and groups. * **memberRelation** *(string) --* The logical relation between members in the condition, determining how multiple user or group conditions are combined. * **users** *(list) --* An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition. * *(dict) --* Represents a user in the document's ACL, used to define access permissions for individual users. * **id** *(string) --* The unique identifier of the user in the document's ACL. This is used to identify the user when applying access rules. * **type** *(string) --* The type of the user. This indicates the scope of the user's applicability in access control. * **groups** *(list) --* An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition. * *(dict) --* Represents a group in the document's ACL, used to define access permissions for multiple users collectively. * **name** *(string) --* The name of the group in the document's ACL. This is used to identify the group when applying access rules. * **type** *(string) --* The type of the group. This indicates the scope of the group's applicability in access control. * **denyList** *(dict) --* The denylist conditions for the document. Users or groups matching these conditions are denied access to the document, overriding allowlist permissions. * **memberRelation** *(string) --* The logical relation between members in the membership rule, determining how multiple conditions are combined. * **conditions** *(list) --* An array of conditions that define the membership rules. Each condition specifies criteria for users or groups to be included in this membership. * *(dict) --* Represents a condition in the document's ACL, specifying access rules for users and groups. * **memberRelation** *(string) --* The logical relation between members in the condition, determining how multiple user or group conditions are combined. * **users** *(list) --* An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition. * *(dict) --* Represents a user in the document's ACL, used to define access permissions for individual users. * **id** *(string) --* The unique identifier of the user in the document's ACL. This is used to identify the user when applying access rules. * **type** *(string) --* The type of the user. This indicates the scope of the user's applicability in access control. * **groups** *(list) --* An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition. * *(dict) --* Represents a group in the document's ACL, used to define access permissions for multiple users collectively. * **name** *(string) --* The name of the group in the document's ACL. This is used to identify the group when applying access rules. * **type** *(string) --* The type of the group. This indicates the scope of the group's applicability in access control. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException" QBusiness / Client / get_application get_application *************** QBusiness.Client.get_application(**kwargs) Gets information about an existing Amazon Q Business application. See also: AWS API Documentation **Request Syntax** response = client.get_application( applicationId='string' ) Parameters: **applicationId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q Business application. Return type: dict Returns: **Response Syntax** { 'displayName': 'string', 'applicationId': 'string', 'applicationArn': 'string', 'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS', 'iamIdentityProviderArn': 'string', 'identityCenterApplicationArn': 'string', 'roleArn': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'description': 'string', 'encryptionConfiguration': { 'kmsKeyId': 'string' }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'error': { 'errorMessage': 'string', 'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound' }, 'attachmentsConfiguration': { 'attachmentsControlMode': 'ENABLED'|'DISABLED' }, 'qAppsConfiguration': { 'qAppsControlMode': 'ENABLED'|'DISABLED' }, 'personalizationConfiguration': { 'personalizationControlMode': 'ENABLED'|'DISABLED' }, 'autoSubscriptionConfiguration': { 'autoSubscribe': 'ENABLED'|'DISABLED', 'defaultSubscriptionType': 'Q_LITE'|'Q_BUSINESS' }, 'clientIdsForOIDC': [ 'string', ], 'quickSightConfiguration': { 'clientNamespace': 'string' } } **Response Structure** * *(dict) --* * **displayName** *(string) --* The name of the Amazon Q Business application. * **applicationId** *(string) --* The identifier of the Amazon Q Business application. * **applicationArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q Business application. * **identityType** *(string) --* The authentication type being used by a Amazon Q Business application. * **iamIdentityProviderArn** *(string) --* The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application. * **identityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application. * **roleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics. * **status** *(string) --* The status of the Amazon Q Business application. * **description** *(string) --* A description for the Amazon Q Business application. * **encryptionConfiguration** *(dict) --* The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys. * **kmsKeyId** *(string) --* The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys. * **createdAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **updatedAt** *(datetime) --* The Unix timestamp when the Amazon Q Business application was last updated. * **error** *(dict) --* If the "Status" field is set to "ERROR", the "ErrorMessage" field contains a description of the error that caused the synchronization to fail. * **errorMessage** *(string) --* The message explaining the Amazon Q Business request error. * **errorCode** *(string) --* The code associated with the Amazon Q Business request error. * **attachmentsConfiguration** *(dict) --* Settings for whether end users can upload files directly during chat. * **attachmentsControlMode** *(string) --* Information about whether file upload during chat functionality is activated for your application. * **qAppsConfiguration** *(dict) --* Settings for whether end users can create and use Amazon Q Apps in the web experience. * **qAppsControlMode** *(string) --* Status information about whether end users can create and use Amazon Q Apps in the web experience. * **personalizationConfiguration** *(dict) --* Configuration information about chat response personalization. For more information, see Personalizing chat responses. * **personalizationControlMode** *(string) --* An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance. * **autoSubscriptionConfiguration** *(dict) --* Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications. * **autoSubscribe** *(string) --* Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management. * **defaultSubscriptionType** *(string) --* Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for "autoSubscribe" is set to "ENABLED" you must select a value for this field. * **clientIdsForOIDC** *(list) --* The OIDC client ID for a Amazon Q Business application. * *(string) --* * **quickSightConfiguration** *(dict) --* The Amazon QuickSight authentication configuration for the Amazon Q Business application. * **clientNamespace** *(string) --* The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations. **Exceptions** * "QBusiness.Client.exceptions.InternalServerException" * "QBusiness.Client.exceptions.ResourceNotFoundException" * "QBusiness.Client.exceptions.ThrottlingException" * "QBusiness.Client.exceptions.ValidationException" * "QBusiness.Client.exceptions.AccessDeniedException"