QConnect ******** Client ====== class QConnect.Client A low-level client representing Amazon Q Connect * Amazon Q actions * Amazon Q data types Note: **Powered by Amazon Bedrock**: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI). Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately. Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real- time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests. Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files. For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the *Amazon Connect Administrator Guide*. import boto3 client = boto3.client('qconnect') These are the available methods: * activate_message_template * can_paginate * close * create_ai_agent * create_ai_agent_version * create_ai_guardrail * create_ai_guardrail_version * create_ai_prompt * create_ai_prompt_version * create_assistant * create_assistant_association * create_content * create_content_association * create_knowledge_base * create_message_template * create_message_template_attachment * create_message_template_version * create_quick_response * create_session * deactivate_message_template * delete_ai_agent * delete_ai_agent_version * delete_ai_guardrail * delete_ai_guardrail_version * delete_ai_prompt * delete_ai_prompt_version * delete_assistant * delete_assistant_association * delete_content * delete_content_association * delete_import_job * delete_knowledge_base * delete_message_template * delete_message_template_attachment * delete_quick_response * get_ai_agent * get_ai_guardrail * get_ai_prompt * get_assistant * get_assistant_association * get_content * get_content_association * get_content_summary * get_import_job * get_knowledge_base * get_message_template * get_next_message * get_paginator * get_quick_response * get_recommendations * get_session * get_waiter * list_ai_agent_versions * list_ai_agents * list_ai_guardrail_versions * list_ai_guardrails * list_ai_prompt_versions * list_ai_prompts * list_assistant_associations * list_assistants * list_content_associations * list_contents * list_import_jobs * list_knowledge_bases * list_message_template_versions * list_message_templates * list_messages * list_quick_responses * list_tags_for_resource * notify_recommendations_received * put_feedback * query_assistant * remove_assistant_ai_agent * remove_knowledge_base_template_uri * render_message_template * search_content * search_message_templates * search_quick_responses * search_sessions * send_message * start_content_upload * start_import_job * tag_resource * untag_resource * update_ai_agent * update_ai_guardrail * update_ai_prompt * update_assistant_ai_agent * update_content * update_knowledge_base_template_uri * update_message_template * update_message_template_metadata * update_quick_response * update_session * update_session_data 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: * ListAIAgentVersions * ListAIAgents * ListAIGuardrailVersions * ListAIGuardrails * ListAIPromptVersions * ListAIPrompts * ListAssistantAssociations * ListAssistants * ListContentAssociations * ListContents * ListImportJobs * ListKnowledgeBases * ListMessageTemplateVersions * ListMessageTemplates * ListMessages * ListQuickResponses * QueryAssistant * SearchContent * SearchMessageTemplates * SearchQuickResponses * SearchSessions QConnect / Paginator / ListContentAssociations ListContentAssociations *********************** class QConnect.Paginator.ListContentAssociations paginator = client.get_paginator('list_content_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_content_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', contentId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. * **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** { 'contentAssociationSummaries': [ { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'contentId': 'string', 'contentArn': 'string', 'contentAssociationId': 'string', 'contentAssociationArn': 'string', 'associationType': 'AMAZON_CONNECT_GUIDE', 'associationData': { 'amazonConnectGuideAssociation': { 'flowId': 'string' } }, 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **contentAssociationSummaries** *(list) --* Summary information about content associations. * *(dict) --* Summary information about a content association. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **contentId** *(string) --* The identifier of the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentAssociationId** *(string) --* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the content association. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The content association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "amazonConnectGuideAssociation". 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'} * **amazonConnectGuideAssociation** *(dict) --* The data of the step-by-step guide association. * **flowId** *(string) --* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListContents ListContents ************ class QConnect.Paginator.ListContents paginator = client.get_paginator('list_contents') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_contents()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'contentSummaries': [ { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **contentSummaries** *(list) --* Information about the content. * *(dict) --* Summary information about the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIAgents ListAIAgents ************ class QConnect.Paginator.ListAIAgents paginator = client.get_paginator('list_ai_agents') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_agents()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', origin='SYSTEM'|'CUSTOMER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **origin** (*string*) -- The origin of the AI Agents to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **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** { 'aiAgentSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'aiAgentArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiAgentSummaries** *(list) --* The summaries of AI Agents. * *(dict) --* The summary of the AI Agent. * **name** *(string) --* The name of the AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **configuration** *(dict) --* The configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfiguratio nData". 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'} * **knowledgeBaseAssociationConfigurationDat a** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfiguratio nData". 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'} * **knowledgeBaseAssociationConfigurationDat a** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfiguratio nData". 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'} * **knowledgeBaseAssociationConfigurationDat a** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **origin** *(string) --* The origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **description** *(string) --* The description of the AI Agent. * **status** *(string) --* The status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListImportJobs ListImportJobs ************** class QConnect.Paginator.ListImportJobs paginator = client.get_paginator('list_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'importJobSummaries': [ { 'importJobId': 'string', 'knowledgeBaseId': 'string', 'uploadId': 'string', 'knowledgeBaseArn': 'string', 'importJobType': 'QUICK_RESPONSES', 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'externalSourceConfiguration': { 'source': 'AMAZON_CONNECT', 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **importJobSummaries** *(list) --* Summary information about the import jobs. * *(dict) --* Summary information about the import job. * **importJobId** *(string) --* The identifier of the import job. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **importJobType** *(string) --* The type of import job. * **status** *(string) --* The status of the import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **lastModifiedTime** *(datetime) --* The timestamp when the import job was last modified. * **metadata** *(dict) --* The metadata fields of the imported Amazon Q in Connect resources. * *(string) --* * *(string) --* * **externalSourceConfiguration** *(dict) --* The configuration information of the external source that the resource data are imported from. * **source** *(string) --* The type of the external data source. * **configuration** *(dict) --* The configuration information of the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "connectConfiguration". 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'} * **connectConfiguration** *(dict) --* The configuration information of the Amazon Connect data source. * **instanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListMessageTemplateVersions ListMessageTemplateVersions *************************** class QConnect.Paginator.ListMessageTemplateVersions paginator = client.get_paginator('list_message_template_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_message_template_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', messageTemplateId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **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** { 'messageTemplateVersionSummaries': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'isActive': True|False, 'versionNumber': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **messageTemplateVersionSummaries** *(list) --* Summary information about the versions of a message template. * *(dict) --* The summary of the message template version. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIPrompts ListAIPrompts ************* class QConnect.Paginator.ListAIPrompts paginator = client.get_paginator('list_ai_prompts') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_prompts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', origin='SYSTEM'|'CUSTOMER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **origin** (*string*) -- The origin of the AI Prompts to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **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** { 'aiPromptSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'aiPromptArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiPromptSummaries** *(list) --* The summaries of the AI Prompts. * *(dict) --* The summary of the AI Prompt. * **name** *(string) --* The name of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **type** *(string) --* The type of this AI Prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. Model Ids supported are: "anthropic.claude-3-haiku-20240307-v1:0". * **apiFormat** *(string) --* The API format used for this AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **description** *(string) --* The description of the AI Prompt. * **status** *(string) --* The status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / SearchSessions SearchSessions ************** class QConnect.Paginator.SearchSessions paginator = client.get_paginator('search_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.search_sessions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression to filter results. * **filters** *(list) --* **[REQUIRED]** The search expression filters. * *(dict) --* A search filter. * **field** *(string) --* **[REQUIRED]** The field on which to filter. * **operator** *(string) --* **[REQUIRED]** The operator to use for comparing the field’s value with the provided value. * **value** *(string) --* **[REQUIRED]** The desired field value on which to filter. * **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** { 'sessionSummaries': [ { 'sessionId': 'string', 'sessionArn': 'string', 'assistantId': 'string', 'assistantArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessionSummaries** *(list) --* Summary information about the sessions. * *(dict) --* Summary information about the session. * **sessionId** *(string) --* The identifier of the session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIAgentVersions ListAIAgentVersions ******************* class QConnect.Paginator.ListAIAgentVersions paginator = client.get_paginator('list_ai_agent_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_agent_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', aiAgentId='string', origin='SYSTEM'|'CUSTOMER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed. * **origin** (*string*) -- The origin of the AI Agent versions to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **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** { 'aiAgentVersionSummaries': [ { 'aiAgentSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'aiAgentArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiAgentVersionSummaries** *(list) --* The summaries of AI Agent versions. * *(dict) --* The summary of the AI Agent version. * **aiAgentSummary** *(dict) --* The data for the summary of the AI Agent version. * **name** *(string) --* The name of the AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **configuration** *(dict) --* The configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationCo nfigurationData". 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'} * **knowledgeBaseAssociationConfigurationD ata** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationCo nfigurationData". 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'} * **knowledgeBaseAssociationConfigurationD ata** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationCo nfigurationData". 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'} * **knowledgeBaseAssociationConfigurationD ata** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **origin** *(string) --* The origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **description** *(string) --* The description of the AI Agent. * **status** *(string) --* The status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Agent version. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListQuickResponses ListQuickResponses ****************** class QConnect.Paginator.ListQuickResponses paginator = client.get_paginator('list_quick_responses') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_quick_responses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'quickResponseSummaries': [ { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'description': 'string', 'lastModifiedBy': 'string', 'isActive': True|False, 'channels': [ 'string', ], 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **quickResponseSummaries** *(list) --* Summary information about the quick responses. * *(dict) --* The summary information about the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The resource status of the quick response. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response summary was last modified. * **description** *(string) --* The description of the quick response. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **isActive** *(boolean) --* Whether the quick response is active. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIGuardrailVersions ListAIGuardrailVersions *********************** class QConnect.Paginator.ListAIGuardrailVersions paginator = client.get_paginator('list_ai_guardrail_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_guardrail_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', aiGuardrailId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed. * **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** { 'aiGuardrailVersionSummaries': [ { 'aiGuardrailSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailId': 'string', 'aiGuardrailArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiGuardrailVersionSummaries** *(list) --* The summaries of the AI Guardrail versions. * *(dict) --* The summary of the AI Guardrail version. * **aiGuardrailSummary** *(dict) --* The data for the summary of the AI Guardrail version. * **name** *(string) --* The name of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **description** *(string) --* A description of the AI Guardrail. * **status** *(string) --* The status of the AI Guardrail. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Guardrail version. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIPromptVersions ListAIPromptVersions ******************** class QConnect.Paginator.ListAIPromptVersions paginator = client.get_paginator('list_ai_prompt_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_prompt_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', aiPromptId='string', origin='SYSTEM'|'CUSTOMER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed. * **origin** (*string*) -- The origin of the AI Prompt versions to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **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** { 'aiPromptVersionSummaries': [ { 'aiPromptSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'aiPromptArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiPromptVersionSummaries** *(list) --* The summaries of the AI Prompt versions. * *(dict) --* The summary of the AI Prompt version. * **aiPromptSummary** *(dict) --* The date for the summary of the AI Prompt version. * **name** *(string) --* The name of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **type** *(string) --* The type of this AI Prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. Model Ids supported are: "anthropic.claude-3-haiku-20240307-v1:0". * **apiFormat** *(string) --* The API format used for this AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **description** *(string) --* The description of the AI Prompt. * **status** *(string) --* The status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Prompt version. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / SearchContent SearchContent ************* class QConnect.Paginator.SearchContent paginator = client.get_paginator('search_content') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.search_content()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression to filter results. * **filters** *(list) --* **[REQUIRED]** The search expression filters. * *(dict) --* A search filter. * **field** *(string) --* **[REQUIRED]** The field on which to filter. * **operator** *(string) --* **[REQUIRED]** The operator to use for comparing the field’s value with the provided value. * **value** *(string) --* **[REQUIRED]** The desired field value on which to filter. * **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** { 'contentSummaries': [ { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **contentSummaries** *(list) --* Summary information about the content. * *(dict) --* Summary information about the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / QueryAssistant QueryAssistant ************** class QConnect.Paginator.QueryAssistant paginator = client.get_paginator('query_assistant') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.query_assistant()". Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', queryText='string', sessionId='string', queryCondition=[ { 'single': { 'field': 'RESULT_TYPE', 'comparator': 'EQUALS', 'value': 'string' } }, ], queryInputData={ 'queryTextInputData': { 'text': 'string' }, 'intentInputData': { 'intentId': 'string' } }, overrideKnowledgeBaseSearchType='HYBRID'|'SEMANTIC', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **queryText** (*string*) -- The text to search for. * **sessionId** (*string*) -- The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **queryCondition** (*list*) -- Information about how to query content. * *(dict) --* Information about how to query content. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "single". * **single** *(dict) --* The condition for the query. * **field** *(string) --* **[REQUIRED]** The name of the field for query condition to query on. * **comparator** *(string) --* **[REQUIRED]** The comparison operator for query condition to query on. * **value** *(string) --* **[REQUIRED]** The value for the query condition to query on. * **queryInputData** (*dict*) -- Information about the query. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "queryTextInputData", "intentInputData". * **queryTextInputData** *(dict) --* Input information for the query. * **text** *(string) --* **[REQUIRED]** The text to search for. * **intentInputData** *(dict) --* Input information for the intent. * **intentId** *(string) --* **[REQUIRED]** The identifier of the Amazon Q intent. * **overrideKnowledgeBaseSearchType** (*string*) -- The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text. * **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** { 'results': [ { 'resultId': 'string', 'document': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'relevanceScore': 123.0, 'data': { 'reference': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'generativeReference': { 'modelId': 'string', 'generationId': 'string' } }, 'details': { 'contentData': { 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'generativeData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'intentDetectedData': { 'intent': 'string', 'intentId': 'string' }, 'sourceContentData': { 'id': 'string', 'type': 'KNOWLEDGE_CONTENT', 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' }, 'citationSpan': { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 } }, 'generativeChunkData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'nextChunkToken': 'string' } } }, 'type': 'KNOWLEDGE_CONTENT'|'INTENT_ANSWER'|'GENERATIVE_ANSWER'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the query. * *(dict) --* Information about the result. * **resultId** *(string) --* The identifier of the result data. * **document** *(dict) --* The document. * **contentReference** *(dict) --* A reference to the content resource. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **title** *(dict) --* The title of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The excerpt from the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **relevanceScore** *(float) --* The relevance score of the results. * **data** *(dict) --* Summary of the recommended content. * **reference** *(dict) --* Reference information about the content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentReference", "generativeReference". 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'} * **contentReference** *(dict) --* Reference information about the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **generativeReference** *(dict) --* Reference information about the generative content. * **modelId** *(string) --* The identifier of the LLM model. * **generationId** *(string) --* The identifier of the LLM model. * **details** *(dict) --* Details about the data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentData", "generativeData", "intentDetectedData", "sourceContentData", "generativeChunkData". 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'} * **contentData** *(dict) --* Details about the content data. * **textData** *(dict) --* Details about the content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **generativeData** *(dict) --* Details about the generative data. * **completion** *(string) --* The LLM response. * **references** *(list) --* The references used to generative the LLM response. * *(dict) --* Summary of the data. * **rankingData** *(dict) --* Details about the generative content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **intentDetectedData** *(dict) --* Details about the intent data. * **intent** *(string) --* The detected intent. * **intentId** *(string) --* The identifier of the detected intent. * **sourceContentData** *(dict) --* Details about the content data. * **id** *(string) --* The identifier of the source content. * **type** *(string) --* The type of the source content. * **textData** *(dict) --* Details about the source content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the source content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **citationSpan** *(dict) --* Contains information about where the text with a citation begins and ends in the generated output. * **beginOffsetInclusive** *(integer) --* Where the text with a citation starts in the generated output. * **endOffsetExclusive** *(integer) --* Where the text with a citation ends in the generated output. * **generativeChunkData** *(dict) --* Details about the generative chunk data. * **completion** *(string) --* A chunk of the LLM response. * **references** *(list) --* The references used to generate the LLM response. * *(dict) --* Summary of the data. * **nextChunkToken** *(string) --* The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks. * **type** *(string) --* The type of the query result. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListKnowledgeBases ListKnowledgeBases ****************** class QConnect.Paginator.ListKnowledgeBases paginator = client.get_paginator('list_knowledge_bases') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_knowledge_bases()". 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** { 'knowledgeBaseSummaries': [ { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'name': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, 'vectorIngestionConfiguration': { 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'description': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **knowledgeBaseSummaries** *(list) --* Information about the knowledge bases. * *(dict) --* Summary information about the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **name** *(string) --* The name of the knowledge base. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **status** *(string) --* The status of the knowledge base summary. * **sourceConfiguration** *(dict) --* Configuration information about the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "appIntegrations", "managedSourceConfiguration". 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'} * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app-integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "webCrawlerConfiguration". 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'} * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/lates t/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **vectorIngestionConfiguration** *(dict) --* Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* The buffer size. * **breakpointPercentileThreshold** *(integer) --* The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* Instructions for interpreting the contents of a document. * **renderingConfiguration** *(dict) --* Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** *(string) --* The description of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAssistants ListAssistants ************** class QConnect.Paginator.ListAssistants paginator = client.get_paginator('list_assistants') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_assistants()". 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** { 'assistantSummaries': [ { 'assistantId': 'string', 'assistantArn': 'string', 'name': 'string', 'type': 'AGENT', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'description': 'string', 'tags': { 'string': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'capabilityConfiguration': { 'type': 'V1'|'V2' }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **assistantSummaries** *(list) --* Information about the assistants. * *(dict) --* Summary information about the assistant. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **name** *(string) --* The name of the assistant. * **type** *(string) --* The type of the assistant. * **status** *(string) --* The status of the assistant. * **description** *(string) --* The description of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **integrationConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **capabilityConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant capability. * **type** *(string) --* The type of Amazon Q in Connect assistant capability. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAIGuardrails ListAIGuardrails **************** class QConnect.Paginator.ListAIGuardrails paginator = client.get_paginator('list_ai_guardrails') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_ai_guardrails()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'aiGuardrailSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailId': 'string', 'aiGuardrailArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aiGuardrailSummaries** *(list) --* The summaries of the AI Guardrails. * *(dict) --* The summary of the AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **description** *(string) --* A description of the AI Guardrail. * **status** *(string) --* The status of the AI Guardrail. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListMessages ListMessages ************ class QConnect.Paginator.ListMessages paginator = client.get_paginator('list_messages') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_messages()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', sessionId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect session. * **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': [ { 'value': { 'text': { 'value': 'string' } }, 'messageId': 'string', 'participant': 'CUSTOMER'|'AGENT'|'BOT', 'timestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **messages** *(list) --* The message information. * *(dict) --* The message output. * **value** *(dict) --* The value of a message data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "text". 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'} * **text** *(dict) --* The message data in text type. * **value** *(string) --* The value of the message data in text type. * **messageId** *(string) --* The identifier of a message. * **participant** *(string) --* The participant of a message. * **timestamp** *(datetime) --* The timestamp of a message. * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListAssistantAssociations ListAssistantAssociations ************************* class QConnect.Paginator.ListAssistantAssociations paginator = client.get_paginator('list_assistant_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_assistant_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assistantId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'assistantAssociationSummaries': [ { 'assistantAssociationId': 'string', 'assistantAssociationArn': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string' } }, 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **assistantAssociationSummaries** *(list) --* Summary information about assistant associations. * *(dict) --* Summary information about the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The association data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociation". 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'} * **knowledgeBaseAssociation** *(dict) --* The knowledge base where output data is sent. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / SearchQuickResponses SearchQuickResponses ******************** class QConnect.Paginator.SearchQuickResponses paginator = client.get_paginator('search_quick_responses') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.search_quick_responses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', searchExpression={ 'queries': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'allowFuzziness': True|False, 'priority': 'HIGH'|'MEDIUM'|'LOW' }, ], 'filters': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'EQUALS'|'PREFIX', 'includeNoExistence': True|False }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' } }, attributes={ 'string': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression for querying the quick response. * **queries** *(list) --* The quick response query expressions. * *(dict) --* The quick response fields to query quick responses by. The following is the list of supported field names. * content * name * description * shortcutKey * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the quick responses by. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the quick responses by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **allowFuzziness** *(boolean) --* Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false. * **priority** *(string) --* The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results. * **filters** *(list) --* The configuration of filtering rules applied to quick response query results. * *(dict) --* The quick response fields to filter the quick response query results by. The following is the list of supported field names. * name * description * shortcutKey * isActive * channels * language * contentType * createdTime * lastModifiedTime * lastModifiedBy * groupingConfiguration.criteria * groupingConfiguration.values * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the quick responses by. * **values** *(list) --* The values of attribute field to filter the quick response by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **orderOnField** *(dict) --* The quick response attribute fields on which the query results are ordered. * **name** *(string) --* **[REQUIRED]** The name of the attribute to order the quick response query results by. * **order** *(string) --* The order at which the quick responses are sorted by. * **attributes** (*dict*) -- The user-defined Amazon Connect contact attributes to be resolved when search results are returned. * *(string) --* * *(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** { 'results': [ { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'contents': { 'plainText': { 'content': 'string' }, 'markdown': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'isActive': True|False, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'shortcutKey': 'string', 'lastModifiedBy': 'string', 'channels': [ 'string', ], 'language': 'string', 'attributesNotInterpolated': [ 'string', ], 'attributesInterpolated': [ 'string', ], 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the quick response search. * *(dict) --* The result of quick response search. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The resource status of the quick response. * **contents** *(dict) --* The contents of the quick response. * **plainText** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **markdown** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response search result data was last modified. * **isActive** *(boolean) --* Whether the quick response is active. * **description** *(string) --* The description of the quick response. * **groupingConfiguration** *(dict) --* The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response search result data. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. * **attributesNotInterpolated** *(list) --* The user defined contact attributes that are not resolved when the search result is returned. * *(string) --* * **attributesInterpolated** *(list) --* The user defined contact attributes that are resolved when the search result is returned. * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / SearchMessageTemplates SearchMessageTemplates ********************** class QConnect.Paginator.SearchMessageTemplates paginator = client.get_paginator('search_message_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.search_message_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', searchExpression={ 'queries': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'allowFuzziness': True|False, 'priority': 'HIGH'|'MEDIUM'|'LOW' }, ], 'filters': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'EQUALS'|'PREFIX', 'includeNoExistence': True|False }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression for querying the message template. * **queries** *(list) --* The message template query expressions. * *(dict) --* The message template fields to query message templates by. The following is the list of supported field names: * name * description * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the message templates by. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the message templates by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **allowFuzziness** *(boolean) --* Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false. * **priority** *(string) --* The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results. * **filters** *(list) --* The configuration of filtering rules applied to message template query results. * *(dict) --* The message template fields to filter the message template query results by. The following is the list of supported field names: * name * description * channel * channelSubtype * language * qualifier * createdTime * lastModifiedTime * lastModifiedBy * groupingConfiguration.criteria * groupingConfiguration.values * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the message templates by. * **values** *(list) --* The values of attribute field to filter the message template by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **orderOnField** *(dict) --* The message template attribute fields on which the query results are ordered. * **name** *(string) --* **[REQUIRED]** The name of the message template. * **order** *(string) --* The order at which the message templates are sorted by. * **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** { 'results': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'isActive': True|False, 'versionNumber': 123, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'language': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the message template search. * *(dict) --* The result of message template search. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **description** *(string) --* The description of the message template. * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Paginator / ListMessageTemplates ListMessageTemplates ******************** class QConnect.Paginator.ListMessageTemplates paginator = client.get_paginator('list_message_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "QConnect.Client.list_message_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( knowledgeBaseId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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** { 'messageTemplateSummaries': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'activeVersionNumber': 123, 'description': 'string', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **messageTemplateSummaries** *(list) --* Summary information about the message template. * *(dict) --* The summary of the message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **activeVersionNumber** *(integer) --* The version number of the message template version that is activated. * **description** *(string) --* The description of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. QConnect / Client / get_ai_prompt get_ai_prompt ************* QConnect.Client.get_ai_prompt(**kwargs) Gets and Amazon Q in Connect AI Prompt. See also: AWS API Documentation **Request Syntax** response = client.get_ai_prompt( assistantId='string', aiPromptId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt. Return type: dict Returns: **Response Syntax** { 'aiPrompt': { 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'aiPromptArn': 'string', 'name': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'templateConfiguration': { 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiPrompt** *(dict) --* The data of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **name** *(string) --* The name of the AI Prompt * **type** *(string) --* The type of this AI Prompt. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. The following model Ids are supported: * "anthropic.claude-3-haiku--v1:0" * "apac.amazon.nova-lite-v1:0" * "apac.amazon.nova-micro-v1:0" * "apac.amazon.nova-pro-v1:0" * "apac.anthropic.claude-3-5-sonnet--v2:0" * "apac.anthropic.claude-3-haiku-20240307-v1:0" * "eu.amazon.nova-lite-v1:0" * "eu.amazon.nova-micro-v1:0" * "eu.amazon.nova-pro-v1:0" * "eu.anthropic.claude-3-7-sonnet-20250219-v1:0" * "eu.anthropic.claude-3-haiku-20240307-v1:0" * "us.amazon.nova-lite-v1:0" * "us.amazon.nova-micro-v1:0" * "us.amazon.nova-pro-v1:0" * "us.anthropic.claude-3-5-haiku-20241022-v1:0" * "us.anthropic.claude-3-7-sonnet-20250219-v1:0" * "us.anthropic.claude-3-haiku-20240307-v1:0" * **apiFormat** *(string) --* The API format used for this AI Prompt. * **templateConfiguration** *(dict) --* The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textFullAIPromptEditTemplateConfiguration". 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'} * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* The YAML text for the AI Prompt template. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **description** *(string) --* The description of the AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **status** *(string) --* The status of the AI Prompt. * **versionNumber** *(integer) --* The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the "aiPromptId" on the request). **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / search_content search_content ************** QConnect.Client.search_content(**kwargs) Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name. See also: AWS API Documentation **Request Syntax** response = client.search_content( nextToken='string', maxResults=123, knowledgeBaseId='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] } ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression to filter results. * **filters** *(list) --* **[REQUIRED]** The search expression filters. * *(dict) --* A search filter. * **field** *(string) --* **[REQUIRED]** The field on which to filter. * **operator** *(string) --* **[REQUIRED]** The operator to use for comparing the field’s value with the provided value. * **value** *(string) --* **[REQUIRED]** The desired field value on which to filter. Return type: dict Returns: **Response Syntax** { 'contentSummaries': [ { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **contentSummaries** *(list) --* Summary information about the content. * *(dict) --* Summary information about the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_paginator get_paginator ************* QConnect.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. QConnect / Client / put_feedback put_feedback ************ QConnect.Client.put_feedback(**kwargs) Provides feedback against the specified assistant for the specified target. This API only supports generative targets. See also: AWS API Documentation **Request Syntax** response = client.put_feedback( assistantId='string', targetId='string', targetType='RECOMMENDATION'|'RESULT', contentFeedback={ 'generativeContentFeedbackData': { 'relevance': 'HELPFUL'|'NOT_HELPFUL' } } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. * **targetId** (*string*) -- **[REQUIRED]** The identifier of the feedback target. * **targetType** (*string*) -- **[REQUIRED]** The type of the feedback target. * **contentFeedback** (*dict*) -- **[REQUIRED]** Information about the feedback provided. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "generativeContentFeedbackData". * **generativeContentFeedbackData** *(dict) --* Information about the feedback for a generative target type. * **relevance** *(string) --* **[REQUIRED]** The relevance of the feedback. Return type: dict Returns: **Response Syntax** { 'assistantId': 'string', 'assistantArn': 'string', 'targetId': 'string', 'targetType': 'RECOMMENDATION'|'RESULT', 'contentFeedback': { 'generativeContentFeedbackData': { 'relevance': 'HELPFUL'|'NOT_HELPFUL' } } } **Response Structure** * *(dict) --* * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **targetId** *(string) --* The identifier of the feedback target. * **targetType** *(string) --* The type of the feedback target. * **contentFeedback** *(dict) --* Information about the feedback provided. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "generativeContentFeedbackData". 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'} * **generativeContentFeedbackData** *(dict) --* Information about the feedback for a generative target type. * **relevance** *(string) --* The relevance of the feedback. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_ai_guardrail_version create_ai_guardrail_version *************************** QConnect.Client.create_ai_guardrail_version(**kwargs) Creates an Amazon Q in Connect AI Guardrail version. See also: AWS API Documentation **Request Syntax** response = client.create_ai_guardrail_version( assistantId='string', aiGuardrailId='string', modifiedTime=datetime(2015, 1, 1), clientToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail. * **modifiedTime** (*datetime*) -- The time the AI Guardrail was last modified. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'aiGuardrail': { 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailArn': 'string', 'aiGuardrailId': 'string', 'name': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'blockedInputMessaging': 'string', 'blockedOutputsMessaging': 'string', 'description': 'string', 'topicPolicyConfig': { 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, 'contentPolicyConfig': { 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, 'wordPolicyConfig': { 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, 'sensitiveInformationPolicyConfig': { 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, 'contextualGroundingPolicyConfig': { 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] }, 'tags': { 'string': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'modifiedTime': datetime(2015, 1, 1) }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiGuardrail** *(dict) --* The data of the AI Guardrail version. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **blockedInputMessaging** *(string) --* The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** *(string) --* The message to return when the AI Guardrail blocks a model response. * **description** *(string) --* A description of the AI Guardrail. * **topicPolicyConfig** *(dict) --* Contains details about topics that the AI Guardrail should identify and deny. * **topicsConfig** *(list) --* A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* The name of the topic to deny. * **definition** *(string) --* A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* Specifies to deny the topic. * **contentPolicyConfig** *(dict) --* Contains details about how to handle harmful content. * **filtersConfig** *(list) --* Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* The harmful category that the content filter is applied to. * **inputStrength** *(string) --* The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** *(dict) --* Contains details about the word policy to configured for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** *(dict) --* Contains details about PII entities and regular expressions to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** *(dict) --* The policy configuration details for the AI Guardrail's contextual grounding policy. * **filtersConfig** *(list) --* The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* The threshold details for the AI Guardrail's contextual grounding filter. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **status** *(string) --* The status of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **versionNumber** *(integer) --* The version number of the AI Guardrail version. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_content_summary get_content_summary ******************* QConnect.Client.get_content_summary(**kwargs) Retrieves summary information about the content. See also: AWS API Documentation **Request Syntax** response = client.get_content_summary( contentId='string', knowledgeBaseId='string' ) Parameters: * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'contentSummary': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **contentSummary** *(dict) --* The content summary. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_ai_agent get_ai_agent ************ QConnect.Client.get_ai_agent(**kwargs) Gets an Amazon Q in Connect AI Agent. See also: AWS API Documentation **Request Syntax** response = client.get_ai_agent( assistantId='string', aiAgentId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'aiAgent': { 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'aiAgentArn': 'string', 'name': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiAgent** *(dict) --* The data of the AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **name** *(string) --* The name of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **configuration** *(dict) --* Configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **description** *(string) --* The description of the AI Agent. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* Specifies the origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **status** *(string) --* The status of the AI Agent. * **versionNumber** *(integer) --* The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the "aiAgentId" on the request). **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / update_content update_content ************** QConnect.Client.update_content(**kwargs) Updates information about the content. See also: AWS API Documentation **Request Syntax** response = client.update_content( knowledgeBaseId='string', contentId='string', revisionId='string', title='string', overrideLinkOutUri='string', removeOverrideLinkOutUri=True|False, metadata={ 'string': 'string' }, uploadId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN. * **revisionId** (*string*) -- The "revisionId" of the content resource to update, taken from an earlier call to "GetContent", "GetContentSummary", "SearchContent", or "ListContents". If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a "PreconditionFailedException". * **title** (*string*) -- The title of the content. * **overrideLinkOutUri** (*string*) -- The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing "overrideLinkOurUri", exclude this argument and set "removeOverrideLinkOutUri" to true. * **removeOverrideLinkOutUri** (*boolean*) -- Unset the existing "overrideLinkOutUri" if it exists. * **metadata** (*dict*) -- A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **uploadId** (*string*) -- A pointer to the uploaded asset. This value is returned by StartContentUpload. Return type: dict Returns: **Response Syntax** { 'content': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'linkOutUri': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **content** *(dict) --* The content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **linkOutUri** *(string) --* The URI of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.PreconditionFailedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / deactivate_message_template deactivate_message_template *************************** QConnect.Client.deactivate_message_template(**kwargs) Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the "$ACTIVE_VERSION" qualifier to reference the version in active status. See also: AWS API Documentation **Request Syntax** response = client.deactivate_message_template( knowledgeBaseId='string', messageTemplateId='string', versionNumber=123 ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **versionNumber** (*integer*) -- **[REQUIRED]** The version number of the message template version to deactivate. Return type: dict Returns: **Response Syntax** { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'versionNumber': 123 } **Response Structure** * *(dict) --* * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **versionNumber** *(integer) --* The version number of the message template version that has been deactivated. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / can_paginate can_paginate ************ QConnect.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. QConnect / Client / delete_ai_guardrail_version delete_ai_guardrail_version *************************** QConnect.Client.delete_ai_guardrail_version(**kwargs) Delete and Amazon Q in Connect AI Guardrail version. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_guardrail_version( assistantId='string', aiGuardrailId='string', versionNumber=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail. * **versionNumber** (*integer*) -- **[REQUIRED]** The version number of the AI Guardrail version to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / render_message_template render_message_template *********************** QConnect.Client.render_message_template(**kwargs) Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing. See also: AWS API Documentation **Request Syntax** response = client.render_message_template( knowledgeBaseId='string', messageTemplateId='string', attributes={ 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. * **attributes** (*dict*) -- **[REQUIRED]** An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'attributesNotInterpolated': [ 'string', ], 'attachments': [ { 'contentDisposition': 'ATTACHMENT', 'name': 'string', 'uploadedTime': datetime(2015, 1, 1), 'url': 'string', 'urlExpiry': datetime(2015, 1, 1), 'attachmentId': 'string' }, ] } **Response Structure** * *(dict) --* * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **attributesNotInterpolated** *(list) --* The attribute keys that are not resolved. * *(string) --* * **attachments** *(list) --* The message template attachments. * *(dict) --* Information about the message template attachment. * **contentDisposition** *(string) --* The presentation information for the attachment file. * **name** *(string) --* The name of the attachment file being uploaded. The name should include the file extension. * **uploadedTime** *(datetime) --* The timestamp when the attachment file was uploaded. * **url** *(string) --* A pre-signed Amazon S3 URL that can be used to download the attachment file. * **urlExpiry** *(datetime) --* The expiration time of the pre-signed Amazon S3 URL. * **attachmentId** *(string) --* The identifier of the attachment file. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / update_knowledge_base_template_uri update_knowledge_base_template_uri ********************************** QConnect.Client.update_knowledge_base_template_uri(**kwargs) Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in "${variable}" format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an "Id" value, and you can set the template URI to "https://myInstanceName.lightning.force.com/lightn ing/r/Knowledge__kav/*${Id}*/view". See also: AWS API Documentation **Request Syntax** response = client.update_knowledge_base_template_uri( knowledgeBaseId='string', templateUri='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **templateUri** (*string*) -- **[REQUIRED]** The template URI to update. Return type: dict Returns: **Response Syntax** { 'knowledgeBase': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'name': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'lastContentModificationTime': datetime(2015, 1, 1), 'vectorIngestionConfiguration': { 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'description': 'string', 'tags': { 'string': 'string' }, 'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS', 'ingestionFailureReasons': [ 'string', ] } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base to update. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **name** *(string) --* The name of the knowledge base. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **status** *(string) --* The status of the knowledge base. * **lastContentModificationTime** *(datetime) --* An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset. * **vectorIngestionConfiguration** *(dict) --* Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* The buffer size. * **breakpointPercentileThreshold** *(integer) --* The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* Instructions for interpreting the contents of a document. * **sourceConfiguration** *(dict) --* Source configuration information about the knowledge base. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "appIntegrations", "managedSourceConfiguration". 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'} * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app- integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "webCrawlerConfiguration". 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'} * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.a mazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **renderingConfiguration** *(dict) --* Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **ingestionStatus** *(string) --* Status of ingestion on data source. * **ingestionFailureReasons** *(list) --* List of failure reasons on ingestion per file. * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / activate_message_template activate_message_template ************************* QConnect.Client.activate_message_template(**kwargs) Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the "$ACTIVE_VERSION" qualifier later to reference the version that is in active status. See also: AWS API Documentation **Request Syntax** response = client.activate_message_template( knowledgeBaseId='string', messageTemplateId='string', versionNumber=123 ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **versionNumber** (*integer*) -- **[REQUIRED]** The version number of the message template version to activate. Return type: dict Returns: **Response Syntax** { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'versionNumber': 123 } **Response Structure** * *(dict) --* * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **versionNumber** *(integer) --* The version number of the message template version that is activated. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_message_template delete_message_template *********************** QConnect.Client.delete_message_template(**kwargs) Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as ":" to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_message_template( knowledgeBaseId='string', messageTemplateId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_assistant_associations list_assistant_associations *************************** QConnect.Client.list_assistant_associations(**kwargs) Lists information about assistant associations. See also: AWS API Documentation **Request Syntax** response = client.list_assistant_associations( nextToken='string', maxResults=123, assistantId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'assistantAssociationSummaries': [ { 'assistantAssociationId': 'string', 'assistantAssociationArn': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string' } }, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **assistantAssociationSummaries** *(list) --* Summary information about assistant associations. * *(dict) --* Summary information about the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The association data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociation". 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'} * **knowledgeBaseAssociation** *(dict) --* The knowledge base where output data is sent. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_message_template get_message_template ******************** QConnect.Client.get_message_template(**kwargs) Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, ":", which is either an actual version number or an Amazon Q Connect managed qualifier "$ACTIVE_VERSION" | "$LATEST". If it is not supplied, then "$LATEST" is assumed implicitly. See also: AWS API Documentation **Request Syntax** response = client.get_message_template( messageTemplateId='string', knowledgeBaseId='string' ) Parameters: * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'messageTemplate': { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'description': 'string', 'language': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'defaultAttributes': { 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, 'attributeTypes': [ 'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM', ], 'attachments': [ { 'contentDisposition': 'ATTACHMENT', 'name': 'string', 'uploadedTime': datetime(2015, 1, 1), 'url': 'string', 'urlExpiry': datetime(2015, 1, 1), 'attachmentId': 'string' }, ], 'isActive': True|False, 'versionNumber': 123, 'messageTemplateContentSha256': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **messageTemplate** *(dict) --* The message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **description** *(string) --* The description of the message template. * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **defaultAttributes** *(dict) --* An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **attributeTypes** *(list) --* The types of attributes contain the message template. * *(string) --* * **attachments** *(list) --* The message template attachments. * *(dict) --* Information about the message template attachment. * **contentDisposition** *(string) --* The presentation information for the attachment file. * **name** *(string) --* The name of the attachment file being uploaded. The name should include the file extension. * **uploadedTime** *(datetime) --* The timestamp when the attachment file was uploaded. * **url** *(string) --* A pre-signed Amazon S3 URL that can be used to download the attachment file. * **urlExpiry** *(datetime) --* The expiration time of the pre-signed Amazon S3 URL. * **attachmentId** *(string) --* The identifier of the attachment file. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **messageTemplateContentSha256** *(string) --* The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_ai_guardrails list_ai_guardrails ****************** QConnect.Client.list_ai_guardrails(**kwargs) Lists the AI Guardrails available on the Amazon Q in Connect assistant. See also: AWS API Documentation **Request Syntax** response = client.list_ai_guardrails( assistantId='string', nextToken='string', maxResults=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'aiGuardrailSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailId': 'string', 'aiGuardrailArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiGuardrailSummaries** *(list) --* The summaries of the AI Guardrails. * *(dict) --* The summary of the AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **description** *(string) --* A description of the AI Guardrail. * **status** *(string) --* The status of the AI Guardrail. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / update_quick_response update_quick_response ********************* QConnect.Client.update_quick_response(**kwargs) Updates an existing Amazon Q in Connect quick response. See also: AWS API Documentation **Request Syntax** response = client.update_quick_response( knowledgeBaseId='string', quickResponseId='string', name='string', content={ 'content': 'string' }, contentType='string', groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] }, removeGroupingConfiguration=True|False, description='string', removeDescription=True|False, shortcutKey='string', removeShortcutKey=True|False, isActive=True|False, channels=[ 'string', ], language='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response. * **name** (*string*) -- The name of the quick response. * **content** (*dict*) -- The updated content of the quick response. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the quick response. * **contentType** (*string*) -- The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **groupingConfiguration** (*dict*) -- The updated grouping configuration of the quick response. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **removeGroupingConfiguration** (*boolean*) -- Whether to remove the grouping configuration of the quick response. * **description** (*string*) -- The updated description of the quick response. * **removeDescription** (*boolean*) -- Whether to remove the description from the quick response. * **shortcutKey** (*string*) -- The shortcut key of the quick response. The value should be unique across the knowledge base. * **removeShortcutKey** (*boolean*) -- Whether to remove the shortcut key of the quick response. * **isActive** (*boolean*) -- Whether the quick response is active. * **channels** (*list*) -- The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** (*string*) -- The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'contents': { 'plainText': { 'content': 'string' }, 'markdown': { 'content': 'string' } }, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'shortcutKey': 'string', 'lastModifiedBy': 'string', 'isActive': True|False, 'channels': [ 'string', ], 'language': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The status of the quick response data. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **contents** *(dict) --* The contents of the quick response. * **plainText** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **markdown** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **description** *(string) --* The description of the quick response. * **groupingConfiguration** *(dict) --* The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **isActive** *(boolean) --* Whether the quick response is active. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.PreconditionFailedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / update_ai_prompt update_ai_prompt **************** QConnect.Client.update_ai_prompt(**kwargs) Updates an AI Prompt. See also: AWS API Documentation **Request Syntax** response = client.update_ai_prompt( clientToken='string', assistantId='string', aiPromptId='string', visibilityStatus='SAVED'|'PUBLISHED', templateConfiguration={ 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, description='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Prompt. * **visibilityStatus** (*string*) -- **[REQUIRED]** The visibility status of the Amazon Q in Connect AI prompt. * **templateConfiguration** (*dict*) -- The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "textFullAIPromptEditTemplateConfiguration". * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* **[REQUIRED]** The YAML text for the AI Prompt template. * **description** (*string*) -- The description of the Amazon Q in Connect AI Prompt. Return type: dict Returns: **Response Syntax** { 'aiPrompt': { 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'aiPromptArn': 'string', 'name': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'templateConfiguration': { 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' } } **Response Structure** * *(dict) --* * **aiPrompt** *(dict) --* The data of the updated Amazon Q in Connect AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **name** *(string) --* The name of the AI Prompt * **type** *(string) --* The type of this AI Prompt. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. The following model Ids are supported: * "anthropic.claude-3-haiku--v1:0" * "apac.amazon.nova-lite-v1:0" * "apac.amazon.nova-micro-v1:0" * "apac.amazon.nova-pro-v1:0" * "apac.anthropic.claude-3-5-sonnet--v2:0" * "apac.anthropic.claude-3-haiku-20240307-v1:0" * "eu.amazon.nova-lite-v1:0" * "eu.amazon.nova-micro-v1:0" * "eu.amazon.nova-pro-v1:0" * "eu.anthropic.claude-3-7-sonnet-20250219-v1:0" * "eu.anthropic.claude-3-haiku-20240307-v1:0" * "us.amazon.nova-lite-v1:0" * "us.amazon.nova-micro-v1:0" * "us.amazon.nova-pro-v1:0" * "us.anthropic.claude-3-5-haiku-20241022-v1:0" * "us.anthropic.claude-3-7-sonnet-20250219-v1:0" * "us.anthropic.claude-3-haiku-20240307-v1:0" * **apiFormat** *(string) --* The API format used for this AI Prompt. * **templateConfiguration** *(dict) --* The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textFullAIPromptEditTemplateConfiguration". 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'} * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* The YAML text for the AI Prompt template. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **description** *(string) --* The description of the AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **status** *(string) --* The status of the AI Prompt. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / update_session update_session ************** QConnect.Client.update_session(**kwargs) Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled. See also: AWS API Documentation **Request Syntax** response = client.update_session( assistantId='string', sessionId='string', description='string', tagFilter={ 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, aiAgentConfiguration={ 'string': { 'aiAgentId': 'string' } } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **description** (*string*) -- The description. * **tagFilter** (*dict*) -- An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **aiAgentConfiguration** (*dict*) -- The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* **[REQUIRED]** The ID of the AI Agent to be configured. Return type: dict Returns: **Response Syntax** { 'session': { 'sessionArn': 'string', 'sessionId': 'string', 'name': 'string', 'description': 'string', 'tags': { 'string': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'tagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } }, 'origin': 'SYSTEM'|'CUSTOMER' } } **Response Structure** * *(dict) --* * **session** *(dict) --* Information about the session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **name** *(string) --* The name of the session. * **description** *(string) --* The description of the session. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **integrationConfiguration** *(dict) --* The configuration information for the session integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **tagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. * **origin** *(string) --* The origin of the Session to be listed. "SYSTEM" for a default Session created by Amazon Q in Connect or "CUSTOMER" for a Session created by calling CreateSession API. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_assistant_association delete_assistant_association **************************** QConnect.Client.delete_assistant_association(**kwargs) Deletes an assistant association. See also: AWS API Documentation **Request Syntax** response = client.delete_assistant_association( assistantAssociationId='string', assistantId='string' ) Parameters: * **assistantAssociationId** (*string*) -- **[REQUIRED]** The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / update_message_template update_message_template *********************** QConnect.Client.update_message_template(**kwargs) Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the "$LATEST" qualifier. Any modification will only apply to the message template that is referenced by the "$LATEST" qualifier. The fields for all available versions will remain unchanged. See also: AWS API Documentation **Request Syntax** response = client.update_message_template( knowledgeBaseId='string', messageTemplateId='string', content={ 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, language='string', defaultAttributes={ 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **content** (*dict*) -- The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "email", "sms". * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **language** (*string*) -- The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **defaultAttributes** (*dict*) -- An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'messageTemplate': { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'description': 'string', 'language': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'defaultAttributes': { 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, 'attributeTypes': [ 'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM', ], 'messageTemplateContentSha256': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **messageTemplate** *(dict) --* The message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **description** *(string) --* The description of the message template. * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **defaultAttributes** *(dict) --* An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **attributeTypes** *(list) --* The types of attributes that the message template contains. * *(string) --* * **messageTemplateContentSha256** *(string) --* The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_message_template create_message_template *********************** QConnect.Client.create_message_template(**kwargs) Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the "$LATEST" qualifier to reference the created message template. See also: AWS API Documentation **Request Syntax** response = client.create_message_template( knowledgeBaseId='string', name='string', content={ 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, description='string', channelSubtype='EMAIL'|'SMS', language='string', defaultAttributes={ 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] }, clientToken='string', tags={ 'string': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the message template. * **content** (*dict*) -- **[REQUIRED]** The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "email", "sms". * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the message template. * **description** (*string*) -- The description of the message template. * **channelSubtype** (*string*) -- **[REQUIRED]** The channel subtype this message template applies to. * **language** (*string*) -- The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **defaultAttributes** (*dict*) -- An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **groupingConfiguration** (*dict*) -- The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'messageTemplate': { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'description': 'string', 'language': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'defaultAttributes': { 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, 'attributeTypes': [ 'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM', ], 'messageTemplateContentSha256': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **messageTemplate** *(dict) --* The message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **description** *(string) --* The description of the message template. * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **defaultAttributes** *(dict) --* An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **attributeTypes** *(list) --* The types of attributes that the message template contains. * *(string) --* * **messageTemplateContentSha256** *(string) --* The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_assistant_association create_assistant_association **************************** QConnect.Client.create_assistant_association(**kwargs) Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association. See also: AWS API Documentation **Request Syntax** response = client.create_assistant_association( assistantId='string', associationType='KNOWLEDGE_BASE', association={ 'knowledgeBaseId': 'string' }, clientToken='string', tags={ 'string': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **associationType** (*string*) -- **[REQUIRED]** The type of association. * **association** (*dict*) -- **[REQUIRED]** The identifier of the associated resource. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseId". * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'assistantAssociation': { 'assistantAssociationId': 'string', 'assistantAssociationArn': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string' } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **assistantAssociation** *(dict) --* The assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* A union type that currently has a single argument, the knowledge base ID. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociation". 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'} * **knowledgeBaseAssociation** *(dict) --* The knowledge base where output data is sent. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_session create_session ************** QConnect.Client.create_session(**kwargs) Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled. See also: AWS API Documentation **Request Syntax** response = client.create_session( clientToken='string', assistantId='string', name='string', description='string', tags={ 'string': 'string' }, tagFilter={ 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, aiAgentConfiguration={ 'string': { 'aiAgentId': 'string' } } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the session. * **description** (*string*) -- The description. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **tagFilter** (*dict*) -- An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **aiAgentConfiguration** (*dict*) -- The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* **[REQUIRED]** The ID of the AI Agent to be configured. Return type: dict Returns: **Response Syntax** { 'session': { 'sessionArn': 'string', 'sessionId': 'string', 'name': 'string', 'description': 'string', 'tags': { 'string': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'tagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } }, 'origin': 'SYSTEM'|'CUSTOMER' } } **Response Structure** * *(dict) --* * **session** *(dict) --* The session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **name** *(string) --* The name of the session. * **description** *(string) --* The description of the session. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **integrationConfiguration** *(dict) --* The configuration information for the session integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **tagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. * **origin** *(string) --* The origin of the Session to be listed. "SYSTEM" for a default Session created by Amazon Q in Connect or "CUSTOMER" for a Session created by calling CreateSession API. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_tags_for_resource list_tags_for_resource ********************** QConnect.Client.list_tags_for_resource(**kwargs) Lists the tags for the specified resource. 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 resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_content_association delete_content_association ************************** QConnect.Client.delete_content_association(**kwargs) Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by- step guides in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_content_association( knowledgeBaseId='string', contentId='string', contentAssociationId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. * **contentAssociationId** (*string*) -- **[REQUIRED]** The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_knowledge_base get_knowledge_base ****************** QConnect.Client.get_knowledge_base(**kwargs) Retrieves information about the knowledge base. See also: AWS API Documentation **Request Syntax** response = client.get_knowledge_base( knowledgeBaseId='string' ) Parameters: **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'knowledgeBase': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'name': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'lastContentModificationTime': datetime(2015, 1, 1), 'vectorIngestionConfiguration': { 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'description': 'string', 'tags': { 'string': 'string' }, 'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS', 'ingestionFailureReasons': [ 'string', ] } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **name** *(string) --* The name of the knowledge base. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **status** *(string) --* The status of the knowledge base. * **lastContentModificationTime** *(datetime) --* An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset. * **vectorIngestionConfiguration** *(dict) --* Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* The buffer size. * **breakpointPercentileThreshold** *(integer) --* The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* Instructions for interpreting the contents of a document. * **sourceConfiguration** *(dict) --* Source configuration information about the knowledge base. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "appIntegrations", "managedSourceConfiguration". 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'} * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app- integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "webCrawlerConfiguration". 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'} * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.a mazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **renderingConfiguration** *(dict) --* Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **ingestionStatus** *(string) --* Status of ingestion on data source. * **ingestionFailureReasons** *(list) --* List of failure reasons on ingestion per file. * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_import_jobs list_import_jobs **************** QConnect.Client.list_import_jobs(**kwargs) Lists information about import jobs. See also: AWS API Documentation **Request Syntax** response = client.list_import_jobs( nextToken='string', maxResults=123, knowledgeBaseId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'importJobSummaries': [ { 'importJobId': 'string', 'knowledgeBaseId': 'string', 'uploadId': 'string', 'knowledgeBaseArn': 'string', 'importJobType': 'QUICK_RESPONSES', 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'externalSourceConfiguration': { 'source': 'AMAZON_CONNECT', 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **importJobSummaries** *(list) --* Summary information about the import jobs. * *(dict) --* Summary information about the import job. * **importJobId** *(string) --* The identifier of the import job. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **importJobType** *(string) --* The type of import job. * **status** *(string) --* The status of the import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **lastModifiedTime** *(datetime) --* The timestamp when the import job was last modified. * **metadata** *(dict) --* The metadata fields of the imported Amazon Q in Connect resources. * *(string) --* * *(string) --* * **externalSourceConfiguration** *(dict) --* The configuration information of the external source that the resource data are imported from. * **source** *(string) --* The type of the external data source. * **configuration** *(dict) --* The configuration information of the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "connectConfiguration". 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'} * **connectConfiguration** *(dict) --* The configuration information of the Amazon Connect data source. * **instanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" QConnect / Client / send_message send_message ************ QConnect.Client.send_message(**kwargs) Submits a message to the Amazon Q in Connect session. See also: AWS API Documentation **Request Syntax** response = client.send_message( assistantId='string', sessionId='string', type='TEXT', message={ 'value': { 'text': { 'value': 'string' } } }, conversationContext={ 'selfServiceConversationHistory': [ { 'turnNumber': 123, 'inputTranscript': 'string', 'botResponse': 'string' }, ] }, configuration={ 'generateFillerMessage': True|False }, clientToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect session. * **type** (*string*) -- **[REQUIRED]** The message type. * **message** (*dict*) -- **[REQUIRED]** The message data to submit to the Amazon Q in Connect session. * **value** *(dict) --* **[REQUIRED]** The message input value. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "text". * **text** *(dict) --* The message data in text type. * **value** *(string) --* The value of the message data in text type. * **conversationContext** (*dict*) -- The conversation context before the Amazon Q in Connect session. * **selfServiceConversationHistory** *(list) --* **[REQUIRED]** The self service conversation history before the Amazon Q in Connect session. * *(dict) --* The conversation history data to included in conversation context data before the Amazon Q in Connect session. * **turnNumber** *(integer) --* **[REQUIRED]** The number of turn of the conversation history data. * **inputTranscript** *(string) --* The input transcript of the conversation history data. * **botResponse** *(string) --* The bot response of the conversation history data. * **configuration** (*dict*) -- The configuration of the SendMessage request. * **generateFillerMessage** *(boolean) --* Generates a filler response when tool selection is "QUESTION". * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'requestMessageId': 'string', 'configuration': { 'generateFillerMessage': True|False }, 'nextMessageToken': 'string' } **Response Structure** * *(dict) --* * **requestMessageId** *(string) --* The identifier of the submitted message. * **configuration** *(dict) --* The configuration of the SendMessage request. * **generateFillerMessage** *(boolean) --* Generates a filler response when tool selection is "QUESTION". * **nextMessageToken** *(string) --* The token for the next message, used by GetNextMessage. **Exceptions** * "QConnect.Client.exceptions.RequestTimeoutException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / get_assistant get_assistant ************* QConnect.Client.get_assistant(**kwargs) Retrieves information about an assistant. See also: AWS API Documentation **Request Syntax** response = client.get_assistant( assistantId='string' ) Parameters: **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'assistant': { 'assistantId': 'string', 'assistantArn': 'string', 'name': 'string', 'type': 'AGENT', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'description': 'string', 'tags': { 'string': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'capabilityConfiguration': { 'type': 'V1'|'V2' }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } } } } **Response Structure** * *(dict) --* * **assistant** *(dict) --* Information about the assistant. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **name** *(string) --* The name. * **type** *(string) --* The type of assistant. * **status** *(string) --* The status of the assistant. * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **integrationConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **capabilityConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant capability. * **type** *(string) --* The type of Amazon Q in Connect assistant capability. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / untag_resource untag_resource ************** QConnect.Client.untag_resource(**kwargs) Removes the specified tags from the specified resource. 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 resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_quick_response get_quick_response ****************** QConnect.Client.get_quick_response(**kwargs) Retrieves the quick response. See also: AWS API Documentation **Request Syntax** response = client.get_quick_response( quickResponseId='string', knowledgeBaseId='string' ) Parameters: * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'contents': { 'plainText': { 'content': 'string' }, 'markdown': { 'content': 'string' } }, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'shortcutKey': 'string', 'lastModifiedBy': 'string', 'isActive': True|False, 'channels': [ 'string', ], 'language': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The status of the quick response data. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **contents** *(dict) --* The contents of the quick response. * **plainText** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **markdown** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **description** *(string) --* The description of the quick response. * **groupingConfiguration** *(dict) --* The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **isActive** *(boolean) --* Whether the quick response is active. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_message_template_versions list_message_template_versions ****************************** QConnect.Client.list_message_template_versions(**kwargs) Lists all the available versions for the specified Amazon Q in Connect message template. See also: AWS API Documentation **Request Syntax** response = client.list_message_template_versions( knowledgeBaseId='string', messageTemplateId='string', nextToken='string', maxResults=123 ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'messageTemplateVersionSummaries': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'isActive': True|False, 'versionNumber': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **messageTemplateVersionSummaries** *(list) --* Summary information about the versions of a message template. * *(dict) --* The summary of the message template version. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_ai_guardrail delete_ai_guardrail ******************* QConnect.Client.delete_ai_guardrail(**kwargs) Deletes an Amazon Q in Connect AI Guardrail. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_guardrail( assistantId='string', aiGuardrailId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_ai_agent delete_ai_agent *************** QConnect.Client.delete_ai_agent(**kwargs) Deletes an Amazon Q in Connect AI Agent. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_agent( assistantId='string', aiAgentId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_quick_responses list_quick_responses ******************** QConnect.Client.list_quick_responses(**kwargs) Lists information about quick response. See also: AWS API Documentation **Request Syntax** response = client.list_quick_responses( nextToken='string', maxResults=123, knowledgeBaseId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'quickResponseSummaries': [ { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'description': 'string', 'lastModifiedBy': 'string', 'isActive': True|False, 'channels': [ 'string', ], 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **quickResponseSummaries** *(list) --* Summary information about the quick responses. * *(dict) --* The summary information about the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The resource status of the quick response. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response summary was last modified. * **description** *(string) --* The description of the quick response. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **isActive** *(boolean) --* Whether the quick response is active. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_contents list_contents ************* QConnect.Client.list_contents(**kwargs) Lists the content. See also: AWS API Documentation **Request Syntax** response = client.list_contents( nextToken='string', maxResults=123, knowledgeBaseId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'contentSummaries': [ { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **contentSummaries** *(list) --* Information about the content. * *(dict) --* Summary information about the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_content delete_content ************** QConnect.Client.delete_content(**kwargs) Deletes the content. See also: AWS API Documentation **Request Syntax** response = client.delete_content( knowledgeBaseId='string', contentId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / search_quick_responses search_quick_responses ********************** QConnect.Client.search_quick_responses(**kwargs) Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base. See also: AWS API Documentation **Request Syntax** response = client.search_quick_responses( knowledgeBaseId='string', searchExpression={ 'queries': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'allowFuzziness': True|False, 'priority': 'HIGH'|'MEDIUM'|'LOW' }, ], 'filters': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'EQUALS'|'PREFIX', 'includeNoExistence': True|False }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' } }, nextToken='string', maxResults=123, attributes={ 'string': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression for querying the quick response. * **queries** *(list) --* The quick response query expressions. * *(dict) --* The quick response fields to query quick responses by. The following is the list of supported field names. * content * name * description * shortcutKey * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the quick responses by. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the quick responses by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **allowFuzziness** *(boolean) --* Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false. * **priority** *(string) --* The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results. * **filters** *(list) --* The configuration of filtering rules applied to quick response query results. * *(dict) --* The quick response fields to filter the quick response query results by. The following is the list of supported field names. * name * description * shortcutKey * isActive * channels * language * contentType * createdTime * lastModifiedTime * lastModifiedBy * groupingConfiguration.criteria * groupingConfiguration.values * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the quick responses by. * **values** *(list) --* The values of attribute field to filter the quick response by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **orderOnField** *(dict) --* The quick response attribute fields on which the query results are ordered. * **name** *(string) --* **[REQUIRED]** The name of the attribute to order the quick response query results by. * **order** *(string) --* The order at which the quick responses are sorted by. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **attributes** (*dict*) -- The user-defined Amazon Connect contact attributes to be resolved when search results are returned. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'results': [ { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'contents': { 'plainText': { 'content': 'string' }, 'markdown': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'isActive': True|False, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'shortcutKey': 'string', 'lastModifiedBy': 'string', 'channels': [ 'string', ], 'language': 'string', 'attributesNotInterpolated': [ 'string', ], 'attributesInterpolated': [ 'string', ], 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the quick response search. * *(dict) --* The result of quick response search. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The resource status of the quick response. * **contents** *(dict) --* The contents of the quick response. * **plainText** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **markdown** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response search result data was last modified. * **isActive** *(boolean) --* Whether the quick response is active. * **description** *(string) --* The description of the quick response. * **groupingConfiguration** *(dict) --* The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response search result data. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. * **attributesNotInterpolated** *(list) --* The user defined contact attributes that are not resolved when the search result is returned. * *(string) --* * **attributesInterpolated** *(list) --* The user defined contact attributes that are resolved when the search result is returned. * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.RequestTimeoutException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_waiter get_waiter ********** QConnect.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" QConnect / Client / get_import_job get_import_job ************** QConnect.Client.get_import_job(**kwargs) Retrieves the started import job. See also: AWS API Documentation **Request Syntax** response = client.get_import_job( importJobId='string', knowledgeBaseId='string' ) Parameters: * **importJobId** (*string*) -- **[REQUIRED]** The identifier of the import job to retrieve. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base that the import job belongs to. Return type: dict Returns: **Response Syntax** { 'importJob': { 'importJobId': 'string', 'knowledgeBaseId': 'string', 'uploadId': 'string', 'knowledgeBaseArn': 'string', 'importJobType': 'QUICK_RESPONSES', 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'url': 'string', 'failedRecordReport': 'string', 'urlExpiry': datetime(2015, 1, 1), 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'externalSourceConfiguration': { 'source': 'AMAZON_CONNECT', 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } } } } } **Response Structure** * *(dict) --* * **importJob** *(dict) --* The import job. * **importJobId** *(string) --* The identifier of the import job. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **importJobType** *(string) --* The type of the import job. * **status** *(string) --* The status of the import job. * **url** *(string) --* The download link to the resource file that is uploaded to the import job. * **failedRecordReport** *(string) --* The link to download the information of resource data that failed to be imported. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **lastModifiedTime** *(datetime) --* The timestamp when the import job data was last modified. * **metadata** *(dict) --* The metadata fields of the imported Amazon Q in Connect resources. * *(string) --* * *(string) --* * **externalSourceConfiguration** *(dict) --* The configuration information of the external data source. * **source** *(string) --* The type of the external data source. * **configuration** *(dict) --* The configuration information of the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "connectConfiguration". 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'} * **connectConfiguration** *(dict) --* The configuration information of the Amazon Connect data source. * **instanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_ai_prompt_version delete_ai_prompt_version ************************ QConnect.Client.delete_ai_prompt_version(**kwargs) Delete and Amazon Q in Connect AI Prompt version. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_prompt_version( assistantId='string', aiPromptId='string', versionNumber=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt. * **versionNumber** (*integer*) -- **[REQUIRED]** The version number of the AI Prompt version to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / get_content_association get_content_association *********************** QConnect.Client.get_content_association(**kwargs) Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by- step guides in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_content_association( knowledgeBaseId='string', contentId='string', contentAssociationId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. * **contentAssociationId** (*string*) -- **[REQUIRED]** The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'contentAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'contentId': 'string', 'contentArn': 'string', 'contentAssociationId': 'string', 'contentAssociationArn': 'string', 'associationType': 'AMAZON_CONNECT_GUIDE', 'associationData': { 'amazonConnectGuideAssociation': { 'flowId': 'string' } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **contentAssociation** *(dict) --* The association between Amazon Q in Connect content and another resource. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **contentId** *(string) --* The identifier of the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentAssociationId** *(string) --* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the content association. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The content association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "amazonConnectGuideAssociation". 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'} * **amazonConnectGuideAssociation** *(dict) --* The data of the step-by-step guide association. * **flowId** *(string) --* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_content create_content ************** QConnect.Client.create_content(**kwargs) Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset. See also: AWS API Documentation **Request Syntax** response = client.create_content( knowledgeBaseId='string', name='string', title='string', overrideLinkOutUri='string', metadata={ 'string': 'string' }, uploadId='string', clientToken='string', tags={ 'string': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API. * **title** (*string*) -- The title of the content. If not set, the title is equal to the name. * **overrideLinkOutUri** (*string*) -- The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. * **metadata** (*dict*) -- A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **uploadId** (*string*) -- **[REQUIRED]** A pointer to the uploaded asset. This value is returned by StartContentUpload. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'content': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'linkOutUri': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **content** *(dict) --* The content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **linkOutUri** *(string) --* The URI of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / remove_assistant_ai_agent remove_assistant_ai_agent ************************* QConnect.Client.remove_assistant_ai_agent(**kwargs) Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant. See also: AWS API Documentation **Request Syntax** response = client.remove_assistant_ai_agent( assistantId='string', aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentType** (*string*) -- **[REQUIRED]** The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / start_import_job start_import_job **************** QConnect.Client.start_import_job(**kwargs) Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. * For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses. See also: AWS API Documentation **Request Syntax** response = client.start_import_job( knowledgeBaseId='string', importJobType='QUICK_RESPONSES', uploadId='string', clientToken='string', metadata={ 'string': 'string' }, externalSourceConfiguration={ 'source': 'AMAZON_CONNECT', 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } } } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * For importing Amazon Q in Connect quick responses, this should be a "QUICK_RESPONSES" type knowledge base. * **importJobType** (*string*) -- **[REQUIRED]** The type of the import job. * For importing quick response resource, set the value to "QUICK_RESPONSES". * **uploadId** (*string*) -- **[REQUIRED]** A pointer to the uploaded asset. This value is returned by StartContentUpload. * **clientToken** (*string*) -- The tags used to organize, track, or control access for this resource. This field is autopopulated if not provided. * **metadata** (*dict*) -- The metadata fields of the imported Amazon Q in Connect resources. * *(string) --* * *(string) --* * **externalSourceConfiguration** (*dict*) -- The configuration information of the external source that the resource data are imported from. * **source** *(string) --* **[REQUIRED]** The type of the external data source. * **configuration** *(dict) --* **[REQUIRED]** The configuration information of the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "connectConfiguration". * **connectConfiguration** *(dict) --* The configuration information of the Amazon Connect data source. * **instanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. Return type: dict Returns: **Response Syntax** { 'importJob': { 'importJobId': 'string', 'knowledgeBaseId': 'string', 'uploadId': 'string', 'knowledgeBaseArn': 'string', 'importJobType': 'QUICK_RESPONSES', 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'url': 'string', 'failedRecordReport': 'string', 'urlExpiry': datetime(2015, 1, 1), 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'externalSourceConfiguration': { 'source': 'AMAZON_CONNECT', 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } } } } } **Response Structure** * *(dict) --* * **importJob** *(dict) --* The import job. * **importJobId** *(string) --* The identifier of the import job. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **importJobType** *(string) --* The type of the import job. * **status** *(string) --* The status of the import job. * **url** *(string) --* The download link to the resource file that is uploaded to the import job. * **failedRecordReport** *(string) --* The link to download the information of resource data that failed to be imported. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **lastModifiedTime** *(datetime) --* The timestamp when the import job data was last modified. * **metadata** *(dict) --* The metadata fields of the imported Amazon Q in Connect resources. * *(string) --* * *(string) --* * **externalSourceConfiguration** *(dict) --* The configuration information of the external data source. * **source** *(string) --* The type of the external data source. * **configuration** *(dict) --* The configuration information of the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "connectConfiguration". 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'} * **connectConfiguration** *(dict) --* The configuration information of the Amazon Connect data source. * **instanceId** *(string) --* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_assistant create_assistant **************** QConnect.Client.create_assistant(**kwargs) Creates an Amazon Q in Connect assistant. See also: AWS API Documentation **Request Syntax** response = client.create_assistant( clientToken='string', name='string', type='AGENT', description='string', tags={ 'string': 'string' }, serverSideEncryptionConfiguration={ 'kmsKeyId': 'string' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **name** (*string*) -- **[REQUIRED]** The name of the assistant. * **type** (*string*) -- **[REQUIRED]** The type of assistant. * **description** (*string*) -- The description of the assistant. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** (*dict*) -- The configuration information for the customer managed key used for encryption. The customer managed key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). Return type: dict Returns: **Response Syntax** { 'assistant': { 'assistantId': 'string', 'assistantArn': 'string', 'name': 'string', 'type': 'AGENT', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'description': 'string', 'tags': { 'string': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'capabilityConfiguration': { 'type': 'V1'|'V2' }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } } } } **Response Structure** * *(dict) --* * **assistant** *(dict) --* Information about the assistant. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **name** *(string) --* The name. * **type** *(string) --* The type of assistant. * **status** *(string) --* The status of the assistant. * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **integrationConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **capabilityConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant capability. * **type** *(string) --* The type of Amazon Q in Connect assistant capability. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" QConnect / Client / notify_recommendations_received notify_recommendations_received ******************************* QConnect.Client.notify_recommendations_received(**kwargs) Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a "waitTimeSeconds" input for long-polling behavior and avoiding duplicate recommendations. See also: AWS API Documentation **Request Syntax** response = client.notify_recommendations_received( assistantId='string', sessionId='string', recommendationIds=[ 'string', ] ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **recommendationIds** (*list*) -- **[REQUIRED]** The identifiers of the recommendations. * *(string) --* Return type: dict Returns: **Response Syntax** { 'recommendationIds': [ 'string', ], 'errors': [ { 'recommendationId': 'string', 'message': 'string' }, ] } **Response Structure** * *(dict) --* * **recommendationIds** *(list) --* The identifiers of the recommendations. * *(string) --* * **errors** *(list) --* The identifiers of recommendations that are causing errors. * *(dict) --* An error occurred when creating a recommendation. * **recommendationId** *(string) --* The identifier of the recommendation that is in error. * **message** *(string) --* A recommendation is causing an error. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_next_message get_next_message **************** QConnect.Client.get_next_message(**kwargs) Retrieves next message on an Amazon Q in Connect session. See also: AWS API Documentation **Request Syntax** response = client.get_next_message( assistantId='string', sessionId='string', nextMessageToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect session. * **nextMessageToken** (*string*) -- **[REQUIRED]** The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message. Return type: dict Returns: **Response Syntax** { 'type': 'TEXT', 'response': { 'value': { 'text': { 'value': 'string' } }, 'messageId': 'string', 'participant': 'CUSTOMER'|'AGENT'|'BOT', 'timestamp': datetime(2015, 1, 1) }, 'requestMessageId': 'string', 'conversationState': { 'status': 'CLOSED'|'READY'|'PROCESSING', 'reason': 'SUCCESS'|'FAILED'|'REJECTED' }, 'nextMessageToken': 'string', 'conversationSessionData': [ { 'key': 'string', 'value': { 'stringValue': 'string' } }, ] } **Response Structure** * *(dict) --* * **type** *(string) --* The type of message response. * **response** *(dict) --* The message response to the requested message. * **value** *(dict) --* The value of a message data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "text". 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'} * **text** *(dict) --* The message data in text type. * **value** *(string) --* The value of the message data in text type. * **messageId** *(string) --* The identifier of a message. * **participant** *(string) --* The participant of a message. * **timestamp** *(datetime) --* The timestamp of a message. * **requestMessageId** *(string) --* The identifier of the submitted message. * **conversationState** *(dict) --* The state of current conversation. * **status** *(string) --* The status of the conversation state. * **reason** *(string) --* The reason of the conversation state. * **nextMessageToken** *(string) --* The token for the next message. * **conversationSessionData** *(list) --* The conversation data stored on an Amazon Q in Connect Session. * *(dict) --* The list of key-value pairs that are stored on the session. * **key** *(string) --* The key of the data stored on the session. * **value** *(dict) --* The value of the data stored on the session. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue". 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) --* The string value of the data stored on the session. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_ai_agent_version delete_ai_agent_version *********************** QConnect.Client.delete_ai_agent_version(**kwargs) Deletes an Amazon Q in Connect AI Agent Version. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_agent_version( assistantId='string', aiAgentId='string', versionNumber=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN. * **versionNumber** (*integer*) -- **[REQUIRED]** The version number of the AI Agent version. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_message_template_version create_message_template_version ******************************* QConnect.Client.create_message_template_version(**kwargs) Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in ":" as the message template identifier. An error is displayed if the supplied "messageTemplateContentSha256" is different from the "messageTemplateContentSha256" of the message template with "$LATEST" qualifier. If multiple "CreateMessageTemplateVersion" requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation. See also: AWS API Documentation **Request Syntax** response = client.create_message_template_version( knowledgeBaseId='string', messageTemplateId='string', messageTemplateContentSha256='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **messageTemplateContentSha256** (*string*) -- The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the "$LATEST" qualifier by default. Return type: dict Returns: **Response Syntax** { 'messageTemplate': { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'description': 'string', 'language': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'defaultAttributes': { 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, 'attributeTypes': [ 'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM', ], 'attachments': [ { 'contentDisposition': 'ATTACHMENT', 'name': 'string', 'uploadedTime': datetime(2015, 1, 1), 'url': 'string', 'urlExpiry': datetime(2015, 1, 1), 'attachmentId': 'string' }, ], 'isActive': True|False, 'versionNumber': 123, 'messageTemplateContentSha256': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **messageTemplate** *(dict) --* The message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **description** *(string) --* The description of the message template. * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **defaultAttributes** *(dict) --* An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **attributeTypes** *(list) --* The types of attributes contain the message template. * *(string) --* * **attachments** *(list) --* The message template attachments. * *(dict) --* Information about the message template attachment. * **contentDisposition** *(string) --* The presentation information for the attachment file. * **name** *(string) --* The name of the attachment file being uploaded. The name should include the file extension. * **uploadedTime** *(datetime) --* The timestamp when the attachment file was uploaded. * **url** *(string) --* A pre-signed Amazon S3 URL that can be used to download the attachment file. * **urlExpiry** *(datetime) --* The expiration time of the pre-signed Amazon S3 URL. * **attachmentId** *(string) --* The identifier of the attachment file. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **messageTemplateContentSha256** *(string) --* The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_assistants list_assistants *************** QConnect.Client.list_assistants(**kwargs) Lists information about assistants. See also: AWS API Documentation **Request Syntax** response = client.list_assistants( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'assistantSummaries': [ { 'assistantId': 'string', 'assistantArn': 'string', 'name': 'string', 'type': 'AGENT', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'description': 'string', 'tags': { 'string': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'capabilityConfiguration': { 'type': 'V1'|'V2' }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **assistantSummaries** *(list) --* Information about the assistants. * *(dict) --* Summary information about the assistant. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **name** *(string) --* The name of the assistant. * **type** *(string) --* The type of the assistant. * **status** *(string) --* The status of the assistant. * **description** *(string) --* The description of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **integrationConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **capabilityConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant capability. * **type** *(string) --* The type of Amazon Q in Connect assistant capability. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" QConnect / Client / query_assistant query_assistant *************** QConnect.Client.query_assistant(**kwargs) Warning: This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.query_assistant( assistantId='string', queryText='string', nextToken='string', maxResults=123, sessionId='string', queryCondition=[ { 'single': { 'field': 'RESULT_TYPE', 'comparator': 'EQUALS', 'value': 'string' } }, ], queryInputData={ 'queryTextInputData': { 'text': 'string' }, 'intentInputData': { 'intentId': 'string' } }, overrideKnowledgeBaseSearchType='HYBRID'|'SEMANTIC' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **queryText** (*string*) -- The text to search for. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **sessionId** (*string*) -- The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **queryCondition** (*list*) -- Information about how to query content. * *(dict) --* Information about how to query content. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "single". * **single** *(dict) --* The condition for the query. * **field** *(string) --* **[REQUIRED]** The name of the field for query condition to query on. * **comparator** *(string) --* **[REQUIRED]** The comparison operator for query condition to query on. * **value** *(string) --* **[REQUIRED]** The value for the query condition to query on. * **queryInputData** (*dict*) -- Information about the query. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "queryTextInputData", "intentInputData". * **queryTextInputData** *(dict) --* Input information for the query. * **text** *(string) --* **[REQUIRED]** The text to search for. * **intentInputData** *(dict) --* Input information for the intent. * **intentId** *(string) --* **[REQUIRED]** The identifier of the Amazon Q intent. * **overrideKnowledgeBaseSearchType** (*string*) -- The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text. Return type: dict Returns: **Response Syntax** { 'results': [ { 'resultId': 'string', 'document': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'relevanceScore': 123.0, 'data': { 'reference': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'generativeReference': { 'modelId': 'string', 'generationId': 'string' } }, 'details': { 'contentData': { 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'generativeData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'intentDetectedData': { 'intent': 'string', 'intentId': 'string' }, 'sourceContentData': { 'id': 'string', 'type': 'KNOWLEDGE_CONTENT', 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' }, 'citationSpan': { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 } }, 'generativeChunkData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'nextChunkToken': 'string' } } }, 'type': 'KNOWLEDGE_CONTENT'|'INTENT_ANSWER'|'GENERATIVE_ANSWER'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the query. * *(dict) --* Information about the result. * **resultId** *(string) --* The identifier of the result data. * **document** *(dict) --* The document. * **contentReference** *(dict) --* A reference to the content resource. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **title** *(dict) --* The title of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The excerpt from the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **relevanceScore** *(float) --* The relevance score of the results. * **data** *(dict) --* Summary of the recommended content. * **reference** *(dict) --* Reference information about the content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentReference", "generativeReference". 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'} * **contentReference** *(dict) --* Reference information about the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **generativeReference** *(dict) --* Reference information about the generative content. * **modelId** *(string) --* The identifier of the LLM model. * **generationId** *(string) --* The identifier of the LLM model. * **details** *(dict) --* Details about the data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentData", "generativeData", "intentDetectedData", "sourceContentData", "generativeChunkData". 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'} * **contentData** *(dict) --* Details about the content data. * **textData** *(dict) --* Details about the content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **generativeData** *(dict) --* Details about the generative data. * **completion** *(string) --* The LLM response. * **references** *(list) --* The references used to generative the LLM response. * *(dict) --* Summary of the data. * **rankingData** *(dict) --* Details about the generative content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **intentDetectedData** *(dict) --* Details about the intent data. * **intent** *(string) --* The detected intent. * **intentId** *(string) --* The identifier of the detected intent. * **sourceContentData** *(dict) --* Details about the content data. * **id** *(string) --* The identifier of the source content. * **type** *(string) --* The type of the source content. * **textData** *(dict) --* Details about the source content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the source content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **citationSpan** *(dict) --* Contains information about where the text with a citation begins and ends in the generated output. * **beginOffsetInclusive** *(integer) --* Where the text with a citation starts in the generated output. * **endOffsetExclusive** *(integer) --* Where the text with a citation ends in the generated output. * **generativeChunkData** *(dict) --* Details about the generative chunk data. * **completion** *(string) --* A chunk of the LLM response. * **references** *(list) --* The references used to generate the LLM response. * *(dict) --* Summary of the data. * **nextChunkToken** *(string) --* The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks. * **type** *(string) --* The type of the query result. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.RequestTimeoutException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / search_message_templates search_message_templates ************************ QConnect.Client.search_message_templates(**kwargs) Searches for Amazon Q in Connect message templates in the specified knowledge base. See also: AWS API Documentation **Request Syntax** response = client.search_message_templates( knowledgeBaseId='string', searchExpression={ 'queries': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'allowFuzziness': True|False, 'priority': 'HIGH'|'MEDIUM'|'LOW' }, ], 'filters': [ { 'name': 'string', 'values': [ 'string', ], 'operator': 'EQUALS'|'PREFIX', 'includeNoExistence': True|False }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' } }, nextToken='string', maxResults=123 ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression for querying the message template. * **queries** *(list) --* The message template query expressions. * *(dict) --* The message template fields to query message templates by. The following is the list of supported field names: * name * description * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the message templates by. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the message templates by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **allowFuzziness** *(boolean) --* Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false. * **priority** *(string) --* The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results. * **filters** *(list) --* The configuration of filtering rules applied to message template query results. * *(dict) --* The message template fields to filter the message template query results by. The following is the list of supported field names: * name * description * channel * channelSubtype * language * qualifier * createdTime * lastModifiedTime * lastModifiedBy * groupingConfiguration.criteria * groupingConfiguration.values * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the message templates by. * **values** *(list) --* The values of attribute field to filter the message template by. * *(string) --* * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **orderOnField** *(dict) --* The message template attribute fields on which the query results are ordered. * **name** *(string) --* **[REQUIRED]** The name of the message template. * **order** *(string) --* The order at which the message templates are sorted by. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'results': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'isActive': True|False, 'versionNumber': 123, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'language': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the message template search. * *(dict) --* The result of message template search. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **isActive** *(boolean) --* Whether the version of the message template is activated. * **versionNumber** *(integer) --* The version number of the message template version. * **description** *(string) --* The description of the message template. * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / get_assistant_association get_assistant_association ************************* QConnect.Client.get_assistant_association(**kwargs) Retrieves information about an assistant association. See also: AWS API Documentation **Request Syntax** response = client.get_assistant_association( assistantAssociationId='string', assistantId='string' ) Parameters: * **assistantAssociationId** (*string*) -- **[REQUIRED]** The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'assistantAssociation': { 'assistantAssociationId': 'string', 'assistantAssociationArn': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string' } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **assistantAssociation** *(dict) --* The assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* A union type that currently has a single argument, the knowledge base ID. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociation". 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'} * **knowledgeBaseAssociation** *(dict) --* The knowledge base where output data is sent. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / update_session_data update_session_data ******************* QConnect.Client.update_session_data(**kwargs) Updates the data stored on an Amazon Q in Connect Session. See also: AWS API Documentation **Request Syntax** response = client.update_session_data( assistantId='string', sessionId='string', namespace='Custom', data=[ { 'key': 'string', 'value': { 'stringValue': 'string' } }, ] ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **namespace** (*string*) -- The namespace into which the session data is stored. Supported namespaces are: Custom * **data** (*list*) -- **[REQUIRED]** The data stored on the Amazon Q in Connect Session. * *(dict) --* The list of key-value pairs that are stored on the session. * **key** *(string) --* **[REQUIRED]** The key of the data stored on the session. * **value** *(dict) --* **[REQUIRED]** The value of the data stored on the session. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue". * **stringValue** *(string) --* The string value of the data stored on the session. Return type: dict Returns: **Response Syntax** { 'sessionArn': 'string', 'sessionId': 'string', 'namespace': 'Custom', 'data': [ { 'key': 'string', 'value': { 'stringValue': 'string' } }, ] } **Response Structure** * *(dict) --* * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **namespace** *(string) --* The namespace into which the session data is stored. Supported namespaces are: Custom * **data** *(list) --* Data stored in the session. * *(dict) --* The list of key-value pairs that are stored on the session. * **key** *(string) --* The key of the data stored on the session. * **value** *(dict) --* The value of the data stored on the session. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue". 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) --* The string value of the data stored on the session. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_messages list_messages ************* QConnect.Client.list_messages(**kwargs) Lists messages on an Amazon Q in Connect session. See also: AWS API Documentation **Request Syntax** response = client.list_messages( assistantId='string', sessionId='string', nextToken='string', maxResults=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect session. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'messages': [ { 'value': { 'text': { 'value': 'string' } }, 'messageId': 'string', 'participant': 'CUSTOMER'|'AGENT'|'BOT', 'timestamp': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **messages** *(list) --* The message information. * *(dict) --* The message output. * **value** *(dict) --* The value of a message data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "text". 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'} * **text** *(dict) --* The message data in text type. * **value** *(string) --* The value of the message data in text type. * **messageId** *(string) --* The identifier of a message. * **participant** *(string) --* The participant of a message. * **timestamp** *(datetime) --* The timestamp of a message. * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_session get_session *********** QConnect.Client.get_session(**kwargs) Retrieves information for a specified session. See also: AWS API Documentation **Request Syntax** response = client.get_session( assistantId='string', sessionId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'session': { 'sessionArn': 'string', 'sessionId': 'string', 'name': 'string', 'description': 'string', 'tags': { 'string': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'tagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } }, 'origin': 'SYSTEM'|'CUSTOMER' } } **Response Structure** * *(dict) --* * **session** *(dict) --* The session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **name** *(string) --* The name of the session. * **description** *(string) --* The description of the session. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **integrationConfiguration** *(dict) --* The configuration information for the session integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **tagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. * **origin** *(string) --* The origin of the Session to be listed. "SYSTEM" for a default Session created by Amazon Q in Connect or "CUSTOMER" for a Session created by calling CreateSession API. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_ai_prompt_version create_ai_prompt_version ************************ QConnect.Client.create_ai_prompt_version(**kwargs) Creates an Amazon Q in Connect AI Prompt version. See also: AWS API Documentation **Request Syntax** response = client.create_ai_prompt_version( assistantId='string', aiPromptId='string', modifiedTime=datetime(2015, 1, 1), clientToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt. * **modifiedTime** (*datetime*) -- The time the AI Prompt was last modified. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'aiPrompt': { 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'aiPromptArn': 'string', 'name': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'templateConfiguration': { 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiPrompt** *(dict) --* The data of the AI Prompt version. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **name** *(string) --* The name of the AI Prompt * **type** *(string) --* The type of this AI Prompt. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. The following model Ids are supported: * "anthropic.claude-3-haiku--v1:0" * "apac.amazon.nova-lite-v1:0" * "apac.amazon.nova-micro-v1:0" * "apac.amazon.nova-pro-v1:0" * "apac.anthropic.claude-3-5-sonnet--v2:0" * "apac.anthropic.claude-3-haiku-20240307-v1:0" * "eu.amazon.nova-lite-v1:0" * "eu.amazon.nova-micro-v1:0" * "eu.amazon.nova-pro-v1:0" * "eu.anthropic.claude-3-7-sonnet-20250219-v1:0" * "eu.anthropic.claude-3-haiku-20240307-v1:0" * "us.amazon.nova-lite-v1:0" * "us.amazon.nova-micro-v1:0" * "us.amazon.nova-pro-v1:0" * "us.anthropic.claude-3-5-haiku-20241022-v1:0" * "us.anthropic.claude-3-7-sonnet-20250219-v1:0" * "us.anthropic.claude-3-haiku-20240307-v1:0" * **apiFormat** *(string) --* The API format used for this AI Prompt. * **templateConfiguration** *(dict) --* The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textFullAIPromptEditTemplateConfiguration". 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'} * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* The YAML text for the AI Prompt template. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **description** *(string) --* The description of the AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **status** *(string) --* The status of the AI Prompt. * **versionNumber** *(integer) --* The version number of the AI Prompt version. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_content_associations list_content_associations ************************* QConnect.Client.list_content_associations(**kwargs) Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by- step guides in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_content_associations( nextToken='string', maxResults=123, knowledgeBaseId='string', contentId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. Return type: dict Returns: **Response Syntax** { 'contentAssociationSummaries': [ { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'contentId': 'string', 'contentArn': 'string', 'contentAssociationId': 'string', 'contentAssociationArn': 'string', 'associationType': 'AMAZON_CONNECT_GUIDE', 'associationData': { 'amazonConnectGuideAssociation': { 'flowId': 'string' } }, 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **contentAssociationSummaries** *(list) --* Summary information about content associations. * *(dict) --* Summary information about a content association. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **contentId** *(string) --* The identifier of the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentAssociationId** *(string) --* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the content association. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The content association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "amazonConnectGuideAssociation". 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'} * **amazonConnectGuideAssociation** *(dict) --* The data of the step-by-step guide association. * **flowId** *(string) --* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_ai_prompt_versions list_ai_prompt_versions *********************** QConnect.Client.list_ai_prompt_versions(**kwargs) Lists AI Prompt versions. See also: AWS API Documentation **Request Syntax** response = client.list_ai_prompt_versions( assistantId='string', aiPromptId='string', nextToken='string', maxResults=123, origin='SYSTEM'|'CUSTOMER' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **origin** (*string*) -- The origin of the AI Prompt versions to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. Return type: dict Returns: **Response Syntax** { 'aiPromptVersionSummaries': [ { 'aiPromptSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'aiPromptArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiPromptVersionSummaries** *(list) --* The summaries of the AI Prompt versions. * *(dict) --* The summary of the AI Prompt version. * **aiPromptSummary** *(dict) --* The date for the summary of the AI Prompt version. * **name** *(string) --* The name of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **type** *(string) --* The type of this AI Prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. Model Ids supported are: "anthropic.claude-3-haiku-20240307-v1:0". * **apiFormat** *(string) --* The API format used for this AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **description** *(string) --* The description of the AI Prompt. * **status** *(string) --* The status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Prompt version. * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_quick_response create_quick_response ********************* QConnect.Client.create_quick_response(**kwargs) Creates an Amazon Q in Connect quick response. See also: AWS API Documentation **Request Syntax** response = client.create_quick_response( knowledgeBaseId='string', name='string', content={ 'content': 'string' }, contentType='string', groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] }, description='string', shortcutKey='string', isActive=True|False, channels=[ 'string', ], language='string', clientToken='string', tags={ 'string': 'string' } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the quick response. * **content** (*dict*) -- **[REQUIRED]** The content of the quick response. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "content". * **content** *(string) --* The content of the quick response. * **contentType** (*string*) -- The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for a quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for a quick response written in richtext. * **groupingConfiguration** (*dict*) -- The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **description** (*string*) -- The description of the quick response. * **shortcutKey** (*string*) -- The shortcut key of the quick response. The value should be unique across the knowledge base. * **isActive** (*boolean*) -- Whether the quick response is active. * **channels** (*list*) -- The Amazon Connect channels this quick response applies to. * *(string) --* * **language** (*string*) -- The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'quickResponseArn': 'string', 'quickResponseId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'contents': { 'plainText': { 'content': 'string' }, 'markdown': { 'content': 'string' } }, 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'shortcutKey': 'string', 'lastModifiedBy': 'string', 'isActive': True|False, 'channels': [ 'string', ], 'language': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** *(string) --* The name of the quick response. * **contentType** *(string) --* The media type of the quick response content. * Use "application/x.quickresponse;format=plain" for quick response written in plain text. * Use "application/x.quickresponse;format=markdown" for quick response written in richtext. * **status** *(string) --* The status of the quick response data. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **contents** *(dict) --* The contents of the quick response. * **plainText** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **markdown** *(dict) --* The container quick response content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the quick response. * **description** *(string) --* The description of the quick response. * **groupingConfiguration** *(dict) --* The configuration information of the user groups that the quick response is accessible to. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **isActive** *(boolean) --* Whether the quick response is active. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_ai_guardrail get_ai_guardrail **************** QConnect.Client.get_ai_guardrail(**kwargs) Gets the Amazon Q in Connect AI Guardrail. See also: AWS API Documentation **Request Syntax** response = client.get_ai_guardrail( assistantId='string', aiGuardrailId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail. Return type: dict Returns: **Response Syntax** { 'aiGuardrail': { 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailArn': 'string', 'aiGuardrailId': 'string', 'name': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'blockedInputMessaging': 'string', 'blockedOutputsMessaging': 'string', 'description': 'string', 'topicPolicyConfig': { 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, 'contentPolicyConfig': { 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, 'wordPolicyConfig': { 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, 'sensitiveInformationPolicyConfig': { 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, 'contextualGroundingPolicyConfig': { 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] }, 'tags': { 'string': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'modifiedTime': datetime(2015, 1, 1) }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiGuardrail** *(dict) --* The data of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **blockedInputMessaging** *(string) --* The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** *(string) --* The message to return when the AI Guardrail blocks a model response. * **description** *(string) --* A description of the AI Guardrail. * **topicPolicyConfig** *(dict) --* Contains details about topics that the AI Guardrail should identify and deny. * **topicsConfig** *(list) --* A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* The name of the topic to deny. * **definition** *(string) --* A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* Specifies to deny the topic. * **contentPolicyConfig** *(dict) --* Contains details about how to handle harmful content. * **filtersConfig** *(list) --* Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* The harmful category that the content filter is applied to. * **inputStrength** *(string) --* The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** *(dict) --* Contains details about the word policy to configured for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** *(dict) --* Contains details about PII entities and regular expressions to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** *(dict) --* The policy configuration details for the AI Guardrail's contextual grounding policy. * **filtersConfig** *(list) --* The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* The threshold details for the AI Guardrail's contextual grounding filter. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **status** *(string) --* The status of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **versionNumber** *(integer) --* The version number of the AI Guardrail version (returned if an AI Guardrail version was specified via use of a qualifier for the "aiGuardrailId" on the request). **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_knowledge_base create_knowledge_base ********************* QConnect.Client.create_knowledge_base(**kwargs) Creates a knowledge base. Note: When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an "InvalidRequestException" error.For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: * Call DeleteKnowledgeBase. * Call DeleteDataIntegration. * Call CreateDataIntegration to recreate the DataIntegration or a create different one. * Call CreateKnowledgeBase. See also: AWS API Documentation **Request Syntax** response = client.create_knowledge_base( clientToken='string', name='string', knowledgeBaseType='EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', sourceConfiguration={ 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, renderingConfiguration={ 'templateUri': 'string' }, vectorIngestionConfiguration={ 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, serverSideEncryptionConfiguration={ 'kmsKeyId': 'string' }, description='string', tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **name** (*string*) -- **[REQUIRED]** The name of the knowledge base. * **knowledgeBaseType** (*string*) -- **[REQUIRED]** The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. * **sourceConfiguration** (*dict*) -- The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "appIntegrations", "managedSourceConfiguration". * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app- integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "webCrawlerConfiguration". * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* **[REQUIRED]** The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **renderingConfiguration** (*dict*) -- Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **vectorIngestionConfiguration** (*dict*) -- Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* **[REQUIRED]** Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre- process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* **[REQUIRED]** The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* **[REQUIRED]** The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* **[REQUIRED]** Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* **[REQUIRED]** The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* **[REQUIRED]** The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* **[REQUIRED]** The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* **[REQUIRED]** The buffer size. * **breakpointPercentileThreshold** *(integer) --* **[REQUIRED]** The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* **[REQUIRED]** The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* **[REQUIRED]** The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* **[REQUIRED]** Instructions for interpreting the contents of a document. * **serverSideEncryptionConfiguration** (*dict*) -- The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** (*string*) -- The description. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'knowledgeBase': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'name': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'lastContentModificationTime': datetime(2015, 1, 1), 'vectorIngestionConfiguration': { 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'description': 'string', 'tags': { 'string': 'string' }, 'ingestionStatus': 'SYNC_FAILED'|'SYNCING_IN_PROGRESS'|'SYNC_SUCCESS'|'CREATE_IN_PROGRESS', 'ingestionFailureReasons': [ 'string', ] } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **name** *(string) --* The name of the knowledge base. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **status** *(string) --* The status of the knowledge base. * **lastContentModificationTime** *(datetime) --* An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset. * **vectorIngestionConfiguration** *(dict) --* Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* The buffer size. * **breakpointPercentileThreshold** *(integer) --* The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* Instructions for interpreting the contents of a document. * **sourceConfiguration** *(dict) --* Source configuration information about the knowledge base. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "appIntegrations", "managedSourceConfiguration". 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'} * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app- integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "webCrawlerConfiguration". 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'} * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.a mazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **renderingConfiguration** *(dict) --* Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **ingestionStatus** *(string) --* Status of ingestion on data source. * **ingestionFailureReasons** *(list) --* List of failure reasons on ingestion per file. * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" QConnect / Client / delete_ai_prompt delete_ai_prompt **************** QConnect.Client.delete_ai_prompt(**kwargs) Deletes an Amazon Q in Connect AI Prompt. See also: AWS API Documentation **Request Syntax** response = client.delete_ai_prompt( assistantId='string', aiPromptId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiPromptId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_knowledge_base delete_knowledge_base ********************* QConnect.Client.delete_knowledge_base(**kwargs) Deletes the knowledge base. Note: When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the *Amazon AppIntegrations API Reference*. See also: AWS API Documentation **Request Syntax** response = client.delete_knowledge_base( knowledgeBaseId='string' ) Parameters: **knowledgeBaseId** (*string*) -- **[REQUIRED]** The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_quick_response delete_quick_response ********************* QConnect.Client.delete_quick_response(**kwargs) Deletes a quick response. See also: AWS API Documentation **Request Syntax** response = client.delete_quick_response( knowledgeBaseId='string', quickResponseId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The knowledge base from which the quick response is deleted. The identifier of the knowledge base. * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_ai_guardrail create_ai_guardrail ******************* QConnect.Client.create_ai_guardrail(**kwargs) Creates an Amazon Q in Connect AI Guardrail. See also: AWS API Documentation **Request Syntax** response = client.create_ai_guardrail( clientToken='string', assistantId='string', name='string', blockedInputMessaging='string', blockedOutputsMessaging='string', visibilityStatus='SAVED'|'PUBLISHED', description='string', topicPolicyConfig={ 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, contentPolicyConfig={ 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, wordPolicyConfig={ 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, sensitiveInformationPolicyConfig={ 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, contextualGroundingPolicyConfig={ 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] }, tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the AI Guardrail. * **blockedInputMessaging** (*string*) -- **[REQUIRED]** The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** (*string*) -- **[REQUIRED]** The message to return when the AI Guardrail blocks a model response. * **visibilityStatus** (*string*) -- **[REQUIRED]** The visibility status of the AI Guardrail. * **description** (*string*) -- A description of the AI Guardrail. * **topicPolicyConfig** (*dict*) -- The topic policies to configure for the AI Guardrail. * **topicsConfig** *(list) --* **[REQUIRED]** A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* **[REQUIRED]** The name of the topic to deny. * **definition** *(string) --* **[REQUIRED]** A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* **[REQUIRED]** Specifies to deny the topic. * **contentPolicyConfig** (*dict*) -- The content filter policies to configure for the AI Guardrail. * **filtersConfig** *(list) --* **[REQUIRED]** Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* **[REQUIRED]** The harmful category that the content filter is applied to. * **inputStrength** *(string) --* **[REQUIRED]** The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* **[REQUIRED]** The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** (*dict*) -- The word policy you configure for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* **[REQUIRED]** Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* **[REQUIRED]** The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** (*dict*) -- The sensitive information policy to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* **[REQUIRED]** Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper- case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* **[REQUIRED]** Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* **[REQUIRED]** The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* **[REQUIRED]** The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* **[REQUIRED]** The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** (*dict*) -- The contextual grounding policy configuration used to create an AI Guardrail. * **filtersConfig** *(list) --* **[REQUIRED]** The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* **[REQUIRED]** The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* **[REQUIRED]** The threshold details for the AI Guardrail's contextual grounding filter. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'aiGuardrail': { 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailArn': 'string', 'aiGuardrailId': 'string', 'name': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'blockedInputMessaging': 'string', 'blockedOutputsMessaging': 'string', 'description': 'string', 'topicPolicyConfig': { 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, 'contentPolicyConfig': { 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, 'wordPolicyConfig': { 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, 'sensitiveInformationPolicyConfig': { 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, 'contextualGroundingPolicyConfig': { 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] }, 'tags': { 'string': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'modifiedTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **aiGuardrail** *(dict) --* The data of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **blockedInputMessaging** *(string) --* The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** *(string) --* The message to return when the AI Guardrail blocks a model response. * **description** *(string) --* A description of the AI Guardrail. * **topicPolicyConfig** *(dict) --* Contains details about topics that the AI Guardrail should identify and deny. * **topicsConfig** *(list) --* A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* The name of the topic to deny. * **definition** *(string) --* A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* Specifies to deny the topic. * **contentPolicyConfig** *(dict) --* Contains details about how to handle harmful content. * **filtersConfig** *(list) --* Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* The harmful category that the content filter is applied to. * **inputStrength** *(string) --* The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** *(dict) --* Contains details about the word policy to configured for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** *(dict) --* Contains details about PII entities and regular expressions to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** *(dict) --* The policy configuration details for the AI Guardrail's contextual grounding policy. * **filtersConfig** *(list) --* The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* The threshold details for the AI Guardrail's contextual grounding filter. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **status** *(string) --* The status of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_content_association create_content_association ************************** QConnect.Client.create_content_association(**kwargs) Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step- by-step guide that you have associated with the content. Note the following limitations: * You can create only one content association for each content resource in a knowledge base. * You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step- by-step guides in the *Amazon Connect Administrator Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_content_association( clientToken='string', knowledgeBaseId='string', contentId='string', associationType='AMAZON_CONNECT_GUIDE', association={ 'amazonConnectGuideAssociation': { 'flowId': 'string' } }, tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. * **associationType** (*string*) -- **[REQUIRED]** The type of association. * **association** (*dict*) -- **[REQUIRED]** The identifier of the associated resource. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "amazonConnectGuideAssociation". * **amazonConnectGuideAssociation** *(dict) --* The data of the step-by-step guide association. * **flowId** *(string) --* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'contentAssociation': { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'contentId': 'string', 'contentArn': 'string', 'contentAssociationId': 'string', 'contentAssociationArn': 'string', 'associationType': 'AMAZON_CONNECT_GUIDE', 'associationData': { 'amazonConnectGuideAssociation': { 'flowId': 'string' } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **contentAssociation** *(dict) --* The association between Amazon Q in Connect content and another resource. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **contentId** *(string) --* The identifier of the content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentAssociationId** *(string) --* The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the content association. * **associationType** *(string) --* The type of association. * **associationData** *(dict) --* The content association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "amazonConnectGuideAssociation". 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'} * **amazonConnectGuideAssociation** *(dict) --* The data of the step-by-step guide association. * **flowId** *(string) --* The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / close close ***** QConnect.Client.close() Closes underlying endpoint connections. QConnect / Client / get_content get_content *********** QConnect.Client.get_content(**kwargs) Retrieves content, including a pre-signed URL to download the content. See also: AWS API Documentation **Request Syntax** response = client.get_content( contentId='string', knowledgeBaseId='string' ) Parameters: * **contentId** (*string*) -- **[REQUIRED]** The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'content': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'revisionId': 'string', 'title': 'string', 'contentType': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'metadata': { 'string': 'string' }, 'tags': { 'string': 'string' }, 'linkOutUri': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **content** *(dict) --* The content. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **title** *(string) --* The title of the content. * **contentType** *(string) --* The media type of the content. * **status** *(string) --* The status of the content. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **linkOutUri** *(string) --* The URI of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_ai_agents list_ai_agents ************** QConnect.Client.list_ai_agents(**kwargs) Lists AI Agents. See also: AWS API Documentation **Request Syntax** response = client.list_ai_agents( assistantId='string', nextToken='string', maxResults=123, origin='SYSTEM'|'CUSTOMER' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **origin** (*string*) -- The origin of the AI Agents to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. Return type: dict Returns: **Response Syntax** { 'aiAgentSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'aiAgentArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiAgentSummaries** *(list) --* The summaries of AI Agents. * *(dict) --* The summary of the AI Agent. * **name** *(string) --* The name of the AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **configuration** *(dict) --* The configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **origin** *(string) --* The origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **description** *(string) --* The description of the AI Agent. * **status** *(string) --* The status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / search_sessions search_sessions *************** QConnect.Client.search_sessions(**kwargs) Searches for sessions. See also: AWS API Documentation **Request Syntax** response = client.search_sessions( nextToken='string', maxResults=123, assistantId='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] } ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression to filter results. * **filters** *(list) --* **[REQUIRED]** The search expression filters. * *(dict) --* A search filter. * **field** *(string) --* **[REQUIRED]** The field on which to filter. * **operator** *(string) --* **[REQUIRED]** The operator to use for comparing the field’s value with the provided value. * **value** *(string) --* **[REQUIRED]** The desired field value on which to filter. Return type: dict Returns: **Response Syntax** { 'sessionSummaries': [ { 'sessionId': 'string', 'sessionArn': 'string', 'assistantId': 'string', 'assistantArn': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessionSummaries** *(list) --* Summary information about the sessions. * *(dict) --* Summary information about the session. * **sessionId** *(string) --* The identifier of the session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / start_content_upload start_content_upload ******************** QConnect.Client.start_content_upload(**kwargs) Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM. See also: AWS API Documentation **Request Syntax** response = client.start_content_upload( knowledgeBaseId='string', contentType='string', presignedUrlTimeToLive=123 ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **contentType** (*string*) -- **[REQUIRED]** The type of content to upload. * **presignedUrlTimeToLive** (*integer*) -- The expected expiration time of the generated presigned URL, specified in minutes. Return type: dict Returns: **Response Syntax** { 'uploadId': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1), 'headersToInclude': { 'string': 'string' } } **Response Structure** * *(dict) --* * **uploadId** *(string) --* The identifier of the upload. * **url** *(string) --* The URL of the upload. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. * **headersToInclude** *(dict) --* The headers to include in the upload. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_message_template_attachment create_message_template_attachment ********************************** QConnect.Client.create_message_template_attachment(**kwargs) Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the "$LATEST" qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre- signed Amazon S3 URL returned in response to download the uploaded file. See also: AWS API Documentation **Request Syntax** response = client.create_message_template_attachment( knowledgeBaseId='string', messageTemplateId='string', contentDisposition='ATTACHMENT', name='string', body='string', clientToken='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **contentDisposition** (*string*) -- **[REQUIRED]** The presentation information for the attachment file. * **name** (*string*) -- **[REQUIRED]** The name of the attachment file being uploaded. The name should include the file extension. * **body** (*string*) -- **[REQUIRED]** The body of the attachment file being uploaded. It should be encoded using base64 encoding. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. Return type: dict Returns: **Response Syntax** { 'attachment': { 'contentDisposition': 'ATTACHMENT', 'name': 'string', 'uploadedTime': datetime(2015, 1, 1), 'url': 'string', 'urlExpiry': datetime(2015, 1, 1), 'attachmentId': 'string' } } **Response Structure** * *(dict) --* * **attachment** *(dict) --* The message template attachment. * **contentDisposition** *(string) --* The presentation information for the attachment file. * **name** *(string) --* The name of the attachment file being uploaded. The name should include the file extension. * **uploadedTime** *(datetime) --* The timestamp when the attachment file was uploaded. * **url** *(string) --* A pre-signed Amazon S3 URL that can be used to download the attachment file. * **urlExpiry** *(datetime) --* The expiration time of the pre-signed Amazon S3 URL. * **attachmentId** *(string) --* The identifier of the attachment file. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_import_job delete_import_job ***************** QConnect.Client.delete_import_job(**kwargs) Deletes the quick response import job. See also: AWS API Documentation **Request Syntax** response = client.delete_import_job( knowledgeBaseId='string', importJobId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. * **importJobId** (*string*) -- **[REQUIRED]** The identifier of the import job to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / update_message_template_metadata update_message_template_metadata ******************************** QConnect.Client.update_message_template_metadata(**kwargs) Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the "$LATEST" qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template. See also: AWS API Documentation **Request Syntax** response = client.update_message_template_metadata( knowledgeBaseId='string', messageTemplateId='string', name='string', description='string', groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **name** (*string*) -- The name of the message template. * **description** (*string*) -- The description of the message template. * **groupingConfiguration** (*dict*) -- The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* Return type: dict Returns: **Response Syntax** { 'messageTemplate': { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'content': { 'email': { 'subject': 'string', 'body': { 'plainText': { 'content': 'string' }, 'html': { 'content': 'string' } }, 'headers': [ { 'name': 'string', 'value': 'string' }, ] }, 'sms': { 'body': { 'plainText': { 'content': 'string' } } } }, 'description': 'string', 'language': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'defaultAttributes': { 'systemAttributes': { 'name': 'string', 'customerEndpoint': { 'address': 'string' }, 'systemEndpoint': { 'address': 'string' } }, 'agentAttributes': { 'firstName': 'string', 'lastName': 'string' }, 'customerProfileAttributes': { 'profileId': 'string', 'profileARN': 'string', 'firstName': 'string', 'middleName': 'string', 'lastName': 'string', 'accountNumber': 'string', 'emailAddress': 'string', 'phoneNumber': 'string', 'additionalInformation': 'string', 'partyType': 'string', 'businessName': 'string', 'birthDate': 'string', 'gender': 'string', 'mobilePhoneNumber': 'string', 'homePhoneNumber': 'string', 'businessPhoneNumber': 'string', 'businessEmailAddress': 'string', 'address1': 'string', 'address2': 'string', 'address3': 'string', 'address4': 'string', 'city': 'string', 'county': 'string', 'country': 'string', 'postalCode': 'string', 'province': 'string', 'state': 'string', 'shippingAddress1': 'string', 'shippingAddress2': 'string', 'shippingAddress3': 'string', 'shippingAddress4': 'string', 'shippingCity': 'string', 'shippingCounty': 'string', 'shippingCountry': 'string', 'shippingPostalCode': 'string', 'shippingProvince': 'string', 'shippingState': 'string', 'mailingAddress1': 'string', 'mailingAddress2': 'string', 'mailingAddress3': 'string', 'mailingAddress4': 'string', 'mailingCity': 'string', 'mailingCounty': 'string', 'mailingCountry': 'string', 'mailingPostalCode': 'string', 'mailingProvince': 'string', 'mailingState': 'string', 'billingAddress1': 'string', 'billingAddress2': 'string', 'billingAddress3': 'string', 'billingAddress4': 'string', 'billingCity': 'string', 'billingCounty': 'string', 'billingCountry': 'string', 'billingPostalCode': 'string', 'billingProvince': 'string', 'billingState': 'string', 'custom': { 'string': 'string' } }, 'customAttributes': { 'string': 'string' } }, 'attributeTypes': [ 'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM', ], 'messageTemplateContentSha256': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **messageTemplate** *(dict) --* The message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **content** *(dict) --* The content of the message template. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "email", "sms". 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'} * **email** *(dict) --* The content of the message template that applies to the email channel subtype. * **subject** *(string) --* The subject line, or title, to use in email messages. * **body** *(dict) --* The body to use in email messages. * **plainText** *(dict) --* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **html** *(dict) --* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **headers** *(list) --* The email headers to include in email messages. * *(dict) --* The email header to include in email messages. * **name** *(string) --* The name of the email header. * **value** *(string) --* The value of the email header. * **sms** *(dict) --* The content of the message template that applies to the SMS channel subtype. * **body** *(dict) --* The body to use in SMS messages. * **plainText** *(dict) --* The message body to use in SMS messages. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "content". 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'} * **content** *(string) --* The content of the message template. * **description** *(string) --* The description of the message template. * **language** *(string) --* The language code value for the language in which the quick response is written. The supported language codes include "de_DE", "en_US", "es_ES", "fr_FR", "id_ID", "it_IT", "ja_JP", "ko_KR", "pt_BR", "zh_CN", "zh_TW" * **groupingConfiguration** *(dict) --* The configuration information of the grouping of Amazon Q in Connect users. * **criteria** *(string) --* The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. * "RoutingProfileArn": Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value. * **values** *(list) --* The list of values that define different groups of Amazon Q in Connect users. * When setting "criteria" to "RoutingProfileArn", you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter. * *(string) --* * **defaultAttributes** *(dict) --* An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable. * **systemAttributes** *(dict) --* The system attributes that are used with the message template. * **name** *(string) --* The name of the task. * **customerEndpoint** *(dict) --* The CustomerEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **systemEndpoint** *(dict) --* The SystemEndpoint attribute. * **address** *(string) --* The customer's phone number if used with "customerEndpoint", or the number the customer dialed to call your contact center if used with "systemEndpoint". * **agentAttributes** *(dict) --* The agent attributes that are used with the message template. * **firstName** *(string) --* The agent’s first name as entered in their Amazon Connect user account. * **lastName** *(string) --* The agent’s last name as entered in their Amazon Connect user account. * **customerProfileAttributes** *(dict) --* The customer profile attributes that are used with the message template. * **profileId** *(string) --* The unique identifier of a customer profile. * **profileARN** *(string) --* The ARN of a customer profile. * **firstName** *(string) --* The customer's first name. * **middleName** *(string) --* The customer's middle name. * **lastName** *(string) --* The customer's last name. * **accountNumber** *(string) --* A unique account number that you have given to the customer. * **emailAddress** *(string) --* The customer's email address, which has not been specified as a personal or business address. * **phoneNumber** *(string) --* The customer's phone number, which has not been specified as a mobile, home, or business number. * **additionalInformation** *(string) --* Any additional information relevant to the customer's profile. * **partyType** *(string) --* The customer's party type. * **businessName** *(string) --* The name of the customer's business. * **birthDate** *(string) --* The customer's birth date. * **gender** *(string) --* The customer's gender. * **mobilePhoneNumber** *(string) --* The customer's mobile phone number. * **homePhoneNumber** *(string) --* The customer's mobile phone number. * **businessPhoneNumber** *(string) --* The customer's business phone number. * **businessEmailAddress** *(string) --* The customer's business email address. * **address1** *(string) --* The first line of a customer address. * **address2** *(string) --* The second line of a customer address. * **address3** *(string) --* The third line of a customer address. * **address4** *(string) --* The fourth line of a customer address. * **city** *(string) --* The city in which a customer lives. * **county** *(string) --* The county in which a customer lives. * **country** *(string) --* The country in which a customer lives. * **postalCode** *(string) --* The postal code of a customer address. * **province** *(string) --* The province in which a customer lives. * **state** *(string) --* The state in which a customer lives. * **shippingAddress1** *(string) --* The first line of a customer’s shipping address. * **shippingAddress2** *(string) --* The second line of a customer’s shipping address. * **shippingAddress3** *(string) --* The third line of a customer’s shipping address. * **shippingAddress4** *(string) --* The fourth line of a customer’s shipping address. * **shippingCity** *(string) --* The city of a customer’s shipping address. * **shippingCounty** *(string) --* The county of a customer’s shipping address. * **shippingCountry** *(string) --* The country of a customer’s shipping address. * **shippingPostalCode** *(string) --* The postal code of a customer’s shipping address. * **shippingProvince** *(string) --* The province of a customer’s shipping address. * **shippingState** *(string) --* The state of a customer’s shipping address. * **mailingAddress1** *(string) --* The first line of a customer’s mailing address. * **mailingAddress2** *(string) --* The second line of a customer’s mailing address. * **mailingAddress3** *(string) --* The third line of a customer’s mailing address. * **mailingAddress4** *(string) --* The fourth line of a customer’s mailing address. * **mailingCity** *(string) --* The city of a customer’s mailing address. * **mailingCounty** *(string) --* The county of a customer’s mailing address. * **mailingCountry** *(string) --* The country of a customer’s mailing address. * **mailingPostalCode** *(string) --* The postal code of a customer’s mailing address. * **mailingProvince** *(string) --* The province of a customer’s mailing address. * **mailingState** *(string) --* The state of a customer’s mailing address. * **billingAddress1** *(string) --* The first line of a customer’s billing address. * **billingAddress2** *(string) --* The second line of a customer’s billing address. * **billingAddress3** *(string) --* The third line of a customer’s billing address. * **billingAddress4** *(string) --* The fourth line of a customer’s billing address. * **billingCity** *(string) --* The city of a customer’s billing address. * **billingCounty** *(string) --* The county of a customer’s billing address. * **billingCountry** *(string) --* The country of a customer’s billing address. * **billingPostalCode** *(string) --* The postal code of a customer’s billing address. * **billingProvince** *(string) --* The province of a customer’s billing address. * **billingState** *(string) --* The state of a customer’s billing address. * **custom** *(dict) --* The custom attributes in customer profile attributes. * *(string) --* * *(string) --* * **customAttributes** *(dict) --* The custom attributes that are used with the message template. * *(string) --* * *(string) --* * **attributeTypes** *(list) --* The types of attributes that the message template contains. * *(string) --* * **messageTemplateContentSha256** *(string) --* The checksum value of the message template content that is referenced by the "$LATEST" qualifier. It can be returned in "MessageTemplateData" or "ExtendedMessageTemplateData". It’s calculated by content, language, "defaultAttributes" and "Attachments" of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / remove_knowledge_base_template_uri remove_knowledge_base_template_uri ********************************** QConnect.Client.remove_knowledge_base_template_uri(**kwargs) Removes a URI template from a knowledge base. See also: AWS API Documentation **Request Syntax** response = client.remove_knowledge_base_template_uri( knowledgeBaseId='string' ) Parameters: **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / get_recommendations get_recommendations ******************* QConnect.Client.get_recommendations(**kwargs) Warning: This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the "waitTimeSeconds" parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant. Danger: This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity. See also: AWS API Documentation **Request Syntax** response = client.get_recommendations( assistantId='string', sessionId='string', maxResults=123, waitTimeSeconds=123, nextChunkToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **waitTimeSeconds** (*integer*) -- The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than "WaitTimeSeconds". If no messages are available and the wait time expires, the call returns successfully with an empty list. * **nextChunkToken** (*string*) -- The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks. Return type: dict Returns: **Response Syntax** { 'recommendations': [ { 'recommendationId': 'string', 'document': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW', 'type': 'KNOWLEDGE_CONTENT'|'GENERATIVE_RESPONSE'|'GENERATIVE_ANSWER'|'DETECTED_INTENT'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK', 'data': { 'reference': { 'contentReference': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'contentArn': 'string', 'contentId': 'string', 'sourceURL': 'string', 'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE' }, 'generativeReference': { 'modelId': 'string', 'generationId': 'string' } }, 'details': { 'contentData': { 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'generativeData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' } }, 'intentDetectedData': { 'intent': 'string', 'intentId': 'string' }, 'sourceContentData': { 'id': 'string', 'type': 'KNOWLEDGE_CONTENT', 'textData': { 'title': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] }, 'excerpt': { 'text': 'string', 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ] } }, 'rankingData': { 'relevanceScore': 123.0, 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW' }, 'citationSpan': { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 } }, 'generativeChunkData': { 'completion': 'string', 'references': [ {'... recursive ...'}, ], 'nextChunkToken': 'string' } } } }, ], 'triggers': [ { 'id': 'string', 'type': 'QUERY'|'GENERATIVE', 'source': 'ISSUE_DETECTION'|'RULE_EVALUATION'|'OTHER', 'data': { 'query': { 'text': 'string' } }, 'recommendationIds': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **recommendations** *(list) --* The recommendations. * *(dict) --* Information about the recommendation. * **recommendationId** *(string) --* The identifier of the recommendation. * **document** *(dict) --* The recommended document. * **contentReference** *(dict) --* A reference to the content resource. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **title** *(dict) --* The title of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The excerpt from the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **relevanceScore** *(float) --* The relevance score of the recommendation. * **relevanceLevel** *(string) --* The relevance level of the recommendation. * **type** *(string) --* The type of recommendation. * **data** *(dict) --* Summary of the recommended content. * **reference** *(dict) --* Reference information about the content. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentReference", "generativeReference". 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'} * **contentReference** *(dict) --* Reference information about the content. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. * **contentArn** *(string) --* The Amazon Resource Name (ARN) of the content. * **contentId** *(string) --* The identifier of the content. * **sourceURL** *(string) --* The web URL of the source content. * **referenceType** *(string) --* The type of reference content. * **generativeReference** *(dict) --* Reference information about the generative content. * **modelId** *(string) --* The identifier of the LLM model. * **generationId** *(string) --* The identifier of the LLM model. * **details** *(dict) --* Details about the data. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "contentData", "generativeData", "intentDetectedData", "sourceContentData", "generativeChunkData". 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'} * **contentData** *(dict) --* Details about the content data. * **textData** *(dict) --* Details about the content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **generativeData** *(dict) --* Details about the generative data. * **completion** *(string) --* The LLM response. * **references** *(list) --* The references used to generative the LLM response. * *(dict) --* Summary of the data. * **rankingData** *(dict) --* Details about the generative content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **intentDetectedData** *(dict) --* Details about the intent data. * **intent** *(string) --* The detected intent. * **intentId** *(string) --* The identifier of the detected intent. * **sourceContentData** *(dict) --* Details about the content data. * **id** *(string) --* The identifier of the source content. * **type** *(string) --* The type of the source content. * **textData** *(dict) --* Details about the source content text data. * **title** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **excerpt** *(dict) --* The text of the document. * **text** *(string) --* Text in the document. * **highlights** *(list) --* Highlights in the document text. * *(dict) --* Offset specification to describe highlighting of document excerpts for rendering search results and recommendations. * **beginOffsetInclusive** *(integer) --* The offset for the start of the highlight. * **endOffsetExclusive** *(integer) --* The offset for the end of the highlight. * **rankingData** *(dict) --* Details about the source content ranking data. * **relevanceScore** *(float) --* The relevance level of the recommendation. * **relevanceLevel** *(string) --* The relevance score of the content. * **citationSpan** *(dict) --* Contains information about where the text with a citation begins and ends in the generated output. * **beginOffsetInclusive** *(integer) --* Where the text with a citation starts in the generated output. * **endOffsetExclusive** *(integer) --* Where the text with a citation ends in the generated output. * **generativeChunkData** *(dict) --* Details about the generative chunk data. * **completion** *(string) --* A chunk of the LLM response. * **references** *(list) --* The references used to generate the LLM response. * *(dict) --* Summary of the data. * **nextChunkToken** *(string) --* The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks. * **triggers** *(list) --* The triggers corresponding to recommendations. * *(dict) --* A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in "recommendationIds" by a single RecommendationTrigger. * **id** *(string) --* The identifier of the recommendation trigger. * **type** *(string) --* The type of recommendation trigger. * **source** *(string) --* The source of the recommendation trigger. * ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue. * RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule. * **data** *(dict) --* A union type containing information related to the trigger. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "query". 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'} * **query** *(dict) --* Data associated with the QUERY RecommendationTriggerType. * **text** *(string) --* The text associated with the recommendation trigger. * **recommendationIds** *(list) --* The identifiers of the recommendations. * *(string) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_ai_prompt create_ai_prompt **************** QConnect.Client.create_ai_prompt(**kwargs) Creates an Amazon Q in Connect AI Prompt. See also: AWS API Documentation **Request Syntax** response = client.create_ai_prompt( clientToken='string', assistantId='string', name='string', type='ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', templateConfiguration={ 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, visibilityStatus='SAVED'|'PUBLISHED', templateType='TEXT', modelId='string', apiFormat='ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', tags={ 'string': 'string' }, description='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the AI Prompt. * **type** (*string*) -- **[REQUIRED]** The type of this AI Prompt. * **templateConfiguration** (*dict*) -- **[REQUIRED]** The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "textFullAIPromptEditTemplateConfiguration". * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* **[REQUIRED]** The YAML text for the AI Prompt template. * **visibilityStatus** (*string*) -- **[REQUIRED]** The visibility status of the AI Prompt. * **templateType** (*string*) -- **[REQUIRED]** The type of the prompt template for this AI Prompt. * **modelId** (*string*) -- **[REQUIRED]** The identifier of the model used for this AI Prompt. * **apiFormat** (*string*) -- **[REQUIRED]** The API Format of the AI Prompt. Recommended values: "MESSAGES | TEXT_COMPLETIONS" Note: The values "ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" will be deprecated. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **description** (*string*) -- The description of the AI Prompt. Return type: dict Returns: **Response Syntax** { 'aiPrompt': { 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'aiPromptArn': 'string', 'name': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'templateConfiguration': { 'textFullAIPromptEditTemplateConfiguration': { 'text': 'string' } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' } } **Response Structure** * *(dict) --* * **aiPrompt** *(dict) --* The data of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **name** *(string) --* The name of the AI Prompt * **type** *(string) --* The type of this AI Prompt. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. The following model Ids are supported: * "anthropic.claude-3-haiku--v1:0" * "apac.amazon.nova-lite-v1:0" * "apac.amazon.nova-micro-v1:0" * "apac.amazon.nova-pro-v1:0" * "apac.anthropic.claude-3-5-sonnet--v2:0" * "apac.anthropic.claude-3-haiku-20240307-v1:0" * "eu.amazon.nova-lite-v1:0" * "eu.amazon.nova-micro-v1:0" * "eu.amazon.nova-pro-v1:0" * "eu.anthropic.claude-3-7-sonnet-20250219-v1:0" * "eu.anthropic.claude-3-haiku-20240307-v1:0" * "us.amazon.nova-lite-v1:0" * "us.amazon.nova-micro-v1:0" * "us.amazon.nova-pro-v1:0" * "us.anthropic.claude-3-5-haiku-20241022-v1:0" * "us.anthropic.claude-3-7-sonnet-20250219-v1:0" * "us.anthropic.claude-3-haiku-20240307-v1:0" * **apiFormat** *(string) --* The API format used for this AI Prompt. * **templateConfiguration** *(dict) --* The configuration of the prompt template for this AI Prompt. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textFullAIPromptEditTemplateConfiguration". 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'} * **textFullAIPromptEditTemplateConfiguration** *(dict) --* The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt. * **text** *(string) --* The YAML text for the AI Prompt template. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **description** *(string) --* The description of the AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **status** *(string) --* The status of the AI Prompt. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_knowledge_bases list_knowledge_bases ******************** QConnect.Client.list_knowledge_bases(**kwargs) Lists the knowledge bases. See also: AWS API Documentation **Request Syntax** response = client.list_knowledge_bases( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'knowledgeBaseSummaries': [ { 'knowledgeBaseId': 'string', 'knowledgeBaseArn': 'string', 'name': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES'|'MESSAGE_TEMPLATES'|'MANAGED', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] }, 'managedSourceConfiguration': { 'webCrawlerConfiguration': { 'urlConfiguration': { 'seedUrls': [ { 'url': 'string' }, ] }, 'crawlerLimits': { 'rateLimit': 123 }, 'inclusionFilters': [ 'string', ], 'exclusionFilters': [ 'string', ], 'scope': 'HOST_ONLY'|'SUBDOMAINS' } } }, 'vectorIngestionConfiguration': { 'chunkingConfiguration': { 'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC', 'fixedSizeChunkingConfiguration': { 'maxTokens': 123, 'overlapPercentage': 123 }, 'hierarchicalChunkingConfiguration': { 'levelConfigurations': [ { 'maxTokens': 123 }, ], 'overlapTokens': 123 }, 'semanticChunkingConfiguration': { 'maxTokens': 123, 'bufferSize': 123, 'breakpointPercentileThreshold': 123 } }, 'parsingConfiguration': { 'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL', 'bedrockFoundationModelConfiguration': { 'modelArn': 'string', 'parsingPrompt': { 'parsingPromptText': 'string' } } } }, 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'description': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **knowledgeBaseSummaries** *(list) --* Information about the knowledge bases. * *(dict) --* Summary information about the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **name** *(string) --* The name of the knowledge base. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **status** *(string) --* The status of the knowledge base summary. * **sourceConfiguration** *(dict) --* Configuration information about the external data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "appIntegrations", "managedSourceConfiguration". 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'} * **appIntegrations** *(dict) --* Configuration information for Amazon AppIntegrations to automatically ingest content. * **appIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content. * For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted" as source fields. * For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least "number", "short_description", "sys_mod_count", "workflow_state", and "active" as source fields. * For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if "objectFields" is not provided, including at least "id", "title", "updated_at", and "draft" as source fields. * For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among "docx", "pdf", "html", "htm", and "txt". * For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The "SourceURI" of your DataIntegration must use the following format: "s3://your_s3_bucket_name". Warning: The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal "app- integrations.amazonaws.com" to perform "s3:ListBucket", "s3:GetObject", and "s3:GetBucketLocation" against the bucket. * **objectFields** *(list) --* The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration. * For Salesforce, you must include at least "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", and "IsDeleted". * For ServiceNow, you must include at least "number", "short_description", "sys_mod_count", "workflow_state", and "active". * For Zendesk, you must include at least "id", "title", "updated_at", and "draft". Make sure to include additional fields. These fields are indexed and used to source recommendations. * *(string) --* * **managedSourceConfiguration** *(dict) --* Source configuration for managed resources. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "webCrawlerConfiguration". 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'} * **webCrawlerConfiguration** *(dict) --* Configuration data for web crawler data source. * **urlConfiguration** *(dict) --* The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. * **seedUrls** *(list) --* List of URLs for crawling. * *(dict) --* A URL for crawling. * **url** *(string) --* URL for crawling * **crawlerLimits** *(dict) --* The configuration of crawl limits for the web URLs. * **rateLimit** *(integer) --* Rate of web URLs retrieved per minute. * **inclusionFilters** *(list) --* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **exclusionFilters** *(list) --* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. * *(string) --* * **scope** *(string) --* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs .aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". * **vectorIngestionConfiguration** *(dict) --* Contains details about how to ingest the documents in a data source. * **chunkingConfiguration** *(dict) --* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. * **chunkingStrategy** *(string) --* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for "NONE", then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. * **fixedSizeChunkingConfiguration** *(dict) --* Configurations for when you choose fixed-size chunking. If you set the "chunkingStrategy" as "NONE", exclude this field. * **maxTokens** *(integer) --* The maximum number of tokens to include in a chunk. * **overlapPercentage** *(integer) --* The percentage of overlap between adjacent chunks of a data source. * **hierarchicalChunkingConfiguration** *(dict) --* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. * **levelConfigurations** *(list) --* Token settings for each layer. * *(dict) --* Token settings for each layer. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain in this layer. * **overlapTokens** *(integer) --* The number of tokens to repeat across chunks in the same layer. * **semanticChunkingConfiguration** *(dict) --* Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing. * **maxTokens** *(integer) --* The maximum number of tokens that a chunk can contain. * **bufferSize** *(integer) --* The buffer size. * **breakpointPercentileThreshold** *(integer) --* The dissimilarity threshold for splitting chunks. * **parsingConfiguration** *(dict) --* A custom parser for data source documents. * **parsingStrategy** *(string) --* The parsing strategy for the data source. * **bedrockFoundationModelConfiguration** *(dict) --* Settings for a foundation model used to parse documents for a data source. * **modelArn** *(string) --* The ARN of the foundation model. * **parsingPrompt** *(dict) --* Instructions for interpreting the contents of a document. * **parsingPromptText** *(string) --* Instructions for interpreting the contents of a document. * **renderingConfiguration** *(dict) --* Information about how to render the content. * **templateUri** *(string) --* A URI template containing exactly one variable in "${variableName} ``format. This can only be set for ``EXTERNAL" knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following: * Salesforce: "Id", "ArticleNumber", "VersionNumber", "Title", "PublishStatus", or "IsDeleted" * ServiceNow: "number", "short_description", "sys_mod_count", "workflow_state", or "active" * Zendesk: "id", "title", "updated_at", or "draft" The variable is replaced with the actual value for a piece of content when calling GetContent. * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **description** *(string) --* The description of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" QConnect / Client / update_ai_agent update_ai_agent *************** QConnect.Client.update_ai_agent(**kwargs) Updates an AI Agent. See also: AWS API Documentation **Request Syntax** response = client.update_ai_agent( clientToken='string', assistantId='string', aiAgentId='string', visibilityStatus='SAVED'|'PUBLISHED', configuration={ 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, description='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent. * **visibilityStatus** (*string*) -- **[REQUIRED]** The visbility status of the Amazon Q in Connect AI Agent. * **configuration** (*dict*) -- The configuration of the Amazon Q in Connect AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **description** (*string*) -- The description of the Amazon Q in Connect AI Agent. Return type: dict Returns: **Response Syntax** { 'aiAgent': { 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'aiAgentArn': 'string', 'name': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' } } **Response Structure** * *(dict) --* * **aiAgent** *(dict) --* The data of the updated Amazon Q in Connect AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **name** *(string) --* The name of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **configuration** *(dict) --* Configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **description** *(string) --* The description of the AI Agent. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* Specifies the origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **status** *(string) --* The status of the AI Agent. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_ai_prompts list_ai_prompts *************** QConnect.Client.list_ai_prompts(**kwargs) Lists the AI Prompts available on the Amazon Q in Connect assistant. See also: AWS API Documentation **Request Syntax** response = client.list_ai_prompts( assistantId='string', nextToken='string', maxResults=123, origin='SYSTEM'|'CUSTOMER' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **origin** (*string*) -- The origin of the AI Prompts to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. Return type: dict Returns: **Response Syntax** { 'aiPromptSummaries': [ { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiPromptId': 'string', 'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION', 'aiPromptArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'templateType': 'TEXT', 'modelId': 'string', 'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS'|'MESSAGES'|'TEXT_COMPLETIONS', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiPromptSummaries** *(list) --* The summaries of the AI Prompts. * *(dict) --* The summary of the AI Prompt. * **name** *(string) --* The name of the AI Prompt. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiPromptId** *(string) --* The identifier of the Amazon Q in Connect AI prompt. * **type** *(string) --* The type of this AI Prompt. * **aiPromptArn** *(string) --* The Amazon Resource Name (ARN) of the AI Prompt. * **modifiedTime** *(datetime) --* The time the AI Prompt was last modified. * **templateType** *(string) --* The type of the prompt template for this AI Prompt. * **modelId** *(string) --* The identifier of the model used for this AI Prompt. Model Ids supported are: "anthropic.claude-3-haiku-20240307-v1:0". * **apiFormat** *(string) --* The API format used for this AI Prompt. * **visibilityStatus** *(string) --* The visibility status of the AI Prompt. * **origin** *(string) --* The origin of the AI Prompt. "SYSTEM" for a default AI Prompt created by Q in Connect or "CUSTOMER" for an AI Prompt created by calling AI Prompt creation APIs. * **description** *(string) --* The description of the AI Prompt. * **status** *(string) --* The status of the AI Prompt. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / tag_resource tag_resource ************ QConnect.Client.tag_resource(**kwargs) Adds the specified tags to the specified resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **tags** (*dict*) -- **[REQUIRED]** The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.TooManyTagsException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_ai_guardrail_versions list_ai_guardrail_versions ************************** QConnect.Client.list_ai_guardrail_versions(**kwargs) Lists AI Guardrail versions. See also: AWS API Documentation **Request Syntax** response = client.list_ai_guardrail_versions( assistantId='string', aiGuardrailId='string', nextToken='string', maxResults=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. Return type: dict Returns: **Response Syntax** { 'aiGuardrailVersionSummaries': [ { 'aiGuardrailSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailId': 'string', 'aiGuardrailArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiGuardrailVersionSummaries** *(list) --* The summaries of the AI Guardrail versions. * *(dict) --* The summary of the AI Guardrail version. * **aiGuardrailSummary** *(dict) --* The data for the summary of the AI Guardrail version. * **name** *(string) --* The name of the AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **description** *(string) --* A description of the AI Guardrail. * **status** *(string) --* The status of the AI Guardrail. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Guardrail version. * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / update_assistant_ai_agent update_assistant_ai_agent ************************* QConnect.Client.update_assistant_ai_agent(**kwargs) Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant. See also: AWS API Documentation **Request Syntax** response = client.update_assistant_ai_agent( assistantId='string', aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', configuration={ 'aiAgentId': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentType** (*string*) -- **[REQUIRED]** The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant. * **configuration** (*dict*) -- **[REQUIRED]** The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant. * **aiAgentId** *(string) --* **[REQUIRED]** The ID of the AI Agent to be configured. Return type: dict Returns: **Response Syntax** { 'assistant': { 'assistantId': 'string', 'assistantArn': 'string', 'name': 'string', 'type': 'AGENT', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'description': 'string', 'tags': { 'string': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'capabilityConfiguration': { 'type': 'V1'|'V2' }, 'aiAgentConfiguration': { 'string': { 'aiAgentId': 'string' } } } } **Response Structure** * *(dict) --* * **assistant** *(dict) --* The assistant data. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **name** *(string) --* The name. * **type** *(string) --* The type of assistant. * **status** *(string) --* The status of the assistant. * **description** *(string) --* The description. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **serverSideEncryptionConfiguration** *(dict) --* The configuration information for the customer managed key used for encryption. This KMS key must have a policy that allows "kms:CreateGrant", "kms:DescribeKey", "kms:Decrypt", and "kms:GenerateDataKey*" permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow "kms:Decrypt", "kms:GenerateDataKey*", and "kms:DescribeKey" permissions to the "connect.amazonaws.com" service principal. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId). * **integrationConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **capabilityConfiguration** *(dict) --* The configuration information for the Amazon Q in Connect assistant capability. * **type** *(string) --* The type of Amazon Q in Connect assistant capability. * **aiAgentConfiguration** *(dict) --* The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant. * *(string) --* * *(dict) --* A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant. * **aiAgentId** *(string) --* The ID of the AI Agent to be configured. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / create_ai_agent_version create_ai_agent_version *********************** QConnect.Client.create_ai_agent_version(**kwargs) Creates and Amazon Q in Connect AI Agent version. See also: AWS API Documentation **Request Syntax** response = client.create_ai_agent_version( assistantId='string', aiAgentId='string', modifiedTime=datetime(2015, 1, 1), clientToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent. * **modifiedTime** (*datetime*) -- The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'aiAgent': { 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'aiAgentArn': 'string', 'name': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' }, 'versionNumber': 123 } **Response Structure** * *(dict) --* * **aiAgent** *(dict) --* The data of the AI Agent version. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **name** *(string) --* The name of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **configuration** *(dict) --* Configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **description** *(string) --* The description of the AI Agent. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* Specifies the origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **status** *(string) --* The status of the AI Agent. * **versionNumber** *(integer) --* The version number of the AI Agent version. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / delete_message_template_attachment delete_message_template_attachment ********************************** QConnect.Client.delete_message_template_attachment(**kwargs) Deletes the attachment file from the Amazon Q in Connect message template that is referenced by "$LATEST" qualifier. Attachments on available message template versions will remain unchanged. See also: AWS API Documentation **Request Syntax** response = client.delete_message_template_attachment( knowledgeBaseId='string', messageTemplateId='string', attachmentId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. * **messageTemplateId** (*string*) -- **[REQUIRED]** The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier. * **attachmentId** (*string*) -- **[REQUIRED]** The identifier of the attachment file. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / update_ai_guardrail update_ai_guardrail ******************* QConnect.Client.update_ai_guardrail(**kwargs) Updates an AI Guardrail. See also: AWS API Documentation **Request Syntax** response = client.update_ai_guardrail( clientToken='string', assistantId='string', aiGuardrailId='string', visibilityStatus='SAVED'|'PUBLISHED', blockedInputMessaging='string', blockedOutputsMessaging='string', description='string', topicPolicyConfig={ 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, contentPolicyConfig={ 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, wordPolicyConfig={ 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, sensitiveInformationPolicyConfig={ 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, contextualGroundingPolicyConfig={ 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiGuardrailId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Guardrail. * **visibilityStatus** (*string*) -- **[REQUIRED]** The visibility status of the Amazon Q in Connect AI Guardrail. * **blockedInputMessaging** (*string*) -- **[REQUIRED]** The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** (*string*) -- **[REQUIRED]** The message to return when the AI Guardrail blocks a model response. * **description** (*string*) -- A description of the AI Guardrail. * **topicPolicyConfig** (*dict*) -- The topic policies to configure for the AI Guardrail. * **topicsConfig** *(list) --* **[REQUIRED]** A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* **[REQUIRED]** The name of the topic to deny. * **definition** *(string) --* **[REQUIRED]** A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* **[REQUIRED]** Specifies to deny the topic. * **contentPolicyConfig** (*dict*) -- The content filter policies to configure for the AI Guardrail. * **filtersConfig** *(list) --* **[REQUIRED]** Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* **[REQUIRED]** The harmful category that the content filter is applied to. * **inputStrength** *(string) --* **[REQUIRED]** The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* **[REQUIRED]** The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** (*dict*) -- The word policy you configure for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* **[REQUIRED]** Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* **[REQUIRED]** The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** (*dict*) -- The sensitive information policy to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* **[REQUIRED]** Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper- case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* **[REQUIRED]** Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* **[REQUIRED]** The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* **[REQUIRED]** The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* **[REQUIRED]** The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** (*dict*) -- The contextual grounding policy configuration used to create an AI Guardrail. * **filtersConfig** *(list) --* **[REQUIRED]** The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* **[REQUIRED]** The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* **[REQUIRED]** The threshold details for the AI Guardrail's contextual grounding filter. Return type: dict Returns: **Response Syntax** { 'aiGuardrail': { 'assistantId': 'string', 'assistantArn': 'string', 'aiGuardrailArn': 'string', 'aiGuardrailId': 'string', 'name': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'blockedInputMessaging': 'string', 'blockedOutputsMessaging': 'string', 'description': 'string', 'topicPolicyConfig': { 'topicsConfig': [ { 'name': 'string', 'definition': 'string', 'examples': [ 'string', ], 'type': 'DENY' }, ] }, 'contentPolicyConfig': { 'filtersConfig': [ { 'type': 'SEXUAL'|'VIOLENCE'|'HATE'|'INSULTS'|'MISCONDUCT'|'PROMPT_ATTACK', 'inputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH', 'outputStrength': 'NONE'|'LOW'|'MEDIUM'|'HIGH' }, ] }, 'wordPolicyConfig': { 'wordsConfig': [ { 'text': 'string' }, ], 'managedWordListsConfig': [ { 'type': 'PROFANITY' }, ] }, 'sensitiveInformationPolicyConfig': { 'piiEntitiesConfig': [ { 'type': 'ADDRESS'|'AGE'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'DRIVER_ID'|'EMAIL'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'IP_ADDRESS'|'LICENSE_PLATE'|'MAC_ADDRESS'|'NAME'|'PASSWORD'|'PHONE'|'PIN'|'SWIFT_CODE'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER'|'URL'|'USERNAME'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'VEHICLE_IDENTIFICATION_NUMBER', 'action': 'BLOCK'|'ANONYMIZE' }, ], 'regexesConfig': [ { 'name': 'string', 'description': 'string', 'pattern': 'string', 'action': 'BLOCK'|'ANONYMIZE' }, ] }, 'contextualGroundingPolicyConfig': { 'filtersConfig': [ { 'type': 'GROUNDING'|'RELEVANCE', 'threshold': 123.0 }, ] }, 'tags': { 'string': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'modifiedTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **aiGuardrail** *(dict) --* The data of the updated Amazon Q in Connect AI Guardrail. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiGuardrailArn** *(string) --* The Amazon Resource Name (ARN) of the AI Guardrail. * **aiGuardrailId** *(string) --* The identifier of the Amazon Q in Connect AI Guardrail. * **name** *(string) --* The name of the AI Guardrail. * **visibilityStatus** *(string) --* The visibility status of the AI Guardrail. * **blockedInputMessaging** *(string) --* The message to return when the AI Guardrail blocks a prompt. * **blockedOutputsMessaging** *(string) --* The message to return when the AI Guardrail blocks a model response. * **description** *(string) --* A description of the AI Guardrail. * **topicPolicyConfig** *(dict) --* Contains details about topics that the AI Guardrail should identify and deny. * **topicsConfig** *(list) --* A list of policies related to topics that the AI Guardrail should deny. * *(dict) --* Details about topics for the AI Guardrail to identify and deny. * **name** *(string) --* The name of the topic to deny. * **definition** *(string) --* A definition of the topic to deny. * **examples** *(list) --* A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. * *(string) --* Text example in topic policy * **type** *(string) --* Specifies to deny the topic. * **contentPolicyConfig** *(dict) --* Contains details about how to handle harmful content. * **filtersConfig** *(list) --* Contains the type of the content filter and how strongly it should apply to prompts and model responses. * *(dict) --* Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs. * **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). * **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. * **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. * **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. * **type** *(string) --* The harmful category that the content filter is applied to. * **inputStrength** *(string) --* The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **outputStrength** *(string) --* The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. * **wordPolicyConfig** *(dict) --* Contains details about the word policy to configured for the AI Guardrail. * **wordsConfig** *(list) --* A list of words to configure for the AI Guardrail. * *(dict) --* A word to configure for the AI Guardrail. * **text** *(string) --* Text of the word configured for the AI Guardrail to block. * **managedWordListsConfig** *(list) --* A list of managed words to configure for the AI Guardrail. * *(dict) --* The managed word list to configure for the AI Guardrail. * **type** *(string) --* The managed word type to configure for the AI Guardrail. * **sensitiveInformationPolicyConfig** *(dict) --* Contains details about PII entities and regular expressions to configure for the AI Guardrail. * **piiEntitiesConfig** *(list) --* A list of PII entities to configure to the AI Guardrail. * *(dict) --* The PII entity to configure for the AI Guardrail. * **type** *(string) --* Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: * **General** * **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. * **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. * **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. * **EMAIL** An email address, such as *marymajor@email.com*. * **PHONE** A phone number. This entity type also includes fax and pager numbers. * **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. * **PASSWORD** An alphanumeric string that is used as a password, such as "** very20special#pass**". * **DRIVER_ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. * **LICENSE_PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. * **VEHICLE_IDENTIFICATION_NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. * **Finance** * **CREDIT_DEBIT_CARD_CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. * **CREDIT_DEBIT_CARD_EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. * **CREDIT_DEBIT_CARD_NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. * **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. * **INTERNATIONAL_BANK_ACCOUNT_NUMBER** An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure. * **SWIFT_CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. * **IT** * **IP_ADDRESS** An IPv4 address, such as *198.51.100.0*. * **MAC_ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). * **URL** A web address, such as *www.example.com*. * **AWS_ACCESS_KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **AWS_SECRET_KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. * **USA specific** * **US_BANK_ACCOUNT_NUMBER** A US bank account number, which is typically 10 to 12 digits long. * **US_BANK_ROUTING_NUMBER** A US bank account routing number. These are typically nine digits long, * **US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. * **US_PASSPORT_NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. * **US_SOCIAL_SECURITY_NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. * **Canada specific** * **CA_HEALTH_NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. * **CA_SOCIAL_INSURANCE_NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the Luhn algorithm . * **UK Specific** * **UK_NATIONAL_HEALTH_SERVICE_NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. * **UK_NATIONAL_INSURANCE_NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. * **UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. * **Custom** * **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc.. * **action** *(string) --* Configure AI Guardrail's action when the PII entity is detected. * **regexesConfig** *(list) --* A list of regular expressions to configure to the AI Guardrail. * *(dict) --* The regular expression to configure for the AI Guardrail. * **name** *(string) --* The name of the regular expression to configure for the AI Guardrail. * **description** *(string) --* The description of the regular expression to configure for the AI Guardrail. * **pattern** *(string) --* The regular expression pattern to configure for the AI Guardrail. * **action** *(string) --* The AI Guardrail action to configure when matching regular expression is detected. * **contextualGroundingPolicyConfig** *(dict) --* The policy configuration details for the AI Guardrail's contextual grounding policy. * **filtersConfig** *(list) --* The filter configuration details for the AI Guardrails contextual grounding policy. * *(dict) --* The filter configuration details for the AI Guardrail's contextual grounding filter. * **type** *(string) --* The filter type for the AI Guardrail's contextual grounding filter. * **threshold** *(float) --* The threshold details for the AI Guardrail's contextual grounding filter. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **status** *(string) --* The status of the AI Guardrail. * **modifiedTime** *(datetime) --* The time the AI Guardrail was last modified. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / list_ai_agent_versions list_ai_agent_versions ********************** QConnect.Client.list_ai_agent_versions(**kwargs) List AI Agent versions. See also: AWS API Documentation **Request Syntax** response = client.list_ai_agent_versions( assistantId='string', aiAgentId='string', nextToken='string', maxResults=123, origin='SYSTEM'|'CUSTOMER' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **aiAgentId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed. * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **origin** (*string*) -- The origin of the AI Agent versions to be listed. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. Return type: dict Returns: **Response Syntax** { 'aiAgentVersionSummaries': [ { 'aiAgentSummary': { 'name': 'string', 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'aiAgentArn': 'string', 'modifiedTime': datetime(2015, 1, 1), 'visibilityStatus': 'SAVED'|'PUBLISHED', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'origin': 'SYSTEM'|'CUSTOMER', 'description': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, 'versionNumber': 123 }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **aiAgentVersionSummaries** *(list) --* The summaries of AI Agent versions. * *(dict) --* The summary of the AI Agent version. * **aiAgentSummary** *(dict) --* The data for the summary of the AI Agent version. * **name** *(string) --* The name of the AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **configuration** *(dict) --* The configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData ** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData ** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData ** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **origin** *(string) --* The origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **description** *(string) --* The description of the AI Agent. * **status** *(string) --* The status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **versionNumber** *(integer) --* The version number for this AI Agent version. * **nextToken** *(string) --* The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ThrottlingException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / create_ai_agent create_ai_agent *************** QConnect.Client.create_ai_agent(**kwargs) Creates an Amazon Q in Connect AI Agent. See also: AWS API Documentation **Request Syntax** response = client.create_ai_agent( clientToken='string', assistantId='string', name='string', type='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', configuration={ 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, visibilityStatus='SAVED'|'PUBLISHED', tags={ 'string': 'string' }, description='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.. This field is autopopulated if not provided. * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **name** (*string*) -- **[REQUIRED]** The name of the AI Agent. * **type** (*string*) -- **[REQUIRED]** The type of the AI Agent. * **configuration** (*dict*) -- **[REQUIRED]** The configuration of the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "knowledgeBaseAssociationConfigurationData". * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "tagCondition", "andConditions", "orConditions". * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "andConditions", "tagCondition". * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* **[REQUIRED]** The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **visibilityStatus** (*string*) -- **[REQUIRED]** The visibility status of the AI Agent. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **description** (*string*) -- The description of the AI Agent. Return type: dict Returns: **Response Syntax** { 'aiAgent': { 'assistantId': 'string', 'assistantArn': 'string', 'aiAgentId': 'string', 'aiAgentArn': 'string', 'name': 'string', 'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE', 'configuration': { 'manualSearchAIAgentConfiguration': { 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'answerRecommendationAIAgentConfiguration': { 'intentLabelingGenerationAIPromptId': 'string', 'queryReformulationAIPromptId': 'string', 'answerGenerationAIPromptId': 'string', 'answerGenerationAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ], 'locale': 'string' }, 'selfServiceAIAgentConfiguration': { 'selfServicePreProcessingAIPromptId': 'string', 'selfServiceAnswerGenerationAIPromptId': 'string', 'selfServiceAIGuardrailId': 'string', 'associationConfigurations': [ { 'associationId': 'string', 'associationType': 'KNOWLEDGE_BASE', 'associationConfigurationData': { 'knowledgeBaseAssociationConfigurationData': { 'contentTagFilter': { 'tagCondition': { 'key': 'string', 'value': 'string' }, 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'orConditions': [ { 'andConditions': [ { 'key': 'string', 'value': 'string' }, ], 'tagCondition': { 'key': 'string', 'value': 'string' } }, ] }, 'maxResults': 123, 'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC' } } }, ] } }, 'modifiedTime': datetime(2015, 1, 1), 'description': 'string', 'visibilityStatus': 'SAVED'|'PUBLISHED', 'tags': { 'string': 'string' }, 'origin': 'SYSTEM'|'CUSTOMER', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED' } } **Response Structure** * *(dict) --* * **aiAgent** *(dict) --* The data of the created AI Agent. * **assistantId** *(string) --* The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. * **aiAgentId** *(string) --* The identifier of the AI Agent. * **aiAgentArn** *(string) --* The Amazon Resource Name (ARN) of the AI agent. * **name** *(string) --* The name of the AI Agent. * **type** *(string) --* The type of the AI Agent. * **configuration** *(dict) --* Configuration for the AI Agent. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "manualSearchAIAgentConfiguration", "answerRecommendationAIAgentConfiguration", "selfServiceAIAgentConfiguration". 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'} * **manualSearchAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "MANUAL_SEARCH". * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **answerRecommendationAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type "ANSWER_RECOMMENDATION". * **intentLabelingGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Intent Labeling prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **queryReformulationAIPromptId** *(string) --* The AI Prompt identifier for the Query Reformulation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Answer Generation prompt used by the "ANSWER_RECOMMENDATION" AI Agent. * **answerGenerationAIGuardrailId** *(string) --* The AI Guardrail identifier for the Answer Generation Guardrail used by the "ANSWER_RECOMMENDATION" AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **locale** *(string) --* The locale to which specifies the language and region settings that determine the response language for QueryAssistant. Note: For more information on supported locales, see Language support for Amazon Q in Connect. * **selfServiceAIAgentConfiguration** *(dict) --* The configuration for AI Agents of type SELF_SERVICE. * **selfServicePreProcessingAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Pre- Processing prompt used by the SELF_SERVICE AI Agent * **selfServiceAnswerGenerationAIPromptId** *(string) --* The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent * **selfServiceAIGuardrailId** *(string) --* The AI Guardrail identifier used by the SELF_SERVICE AI Agent. * **associationConfigurations** *(list) --* The association configurations for overriding behavior on this AI Agent. * *(dict) --* The configuration for an Amazon Q in Connect Assistant Association. * **associationId** *(string) --* The identifier of the association for this Association Configuration. * **associationType** *(string) --* The type of the association for this Association Configuration. * **associationConfigurationData** *(dict) --* The data of the configuration for an Amazon Q in Connect Assistant Association. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "knowledgeBaseAssociationConfigurationData". 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'} * **knowledgeBaseAssociationConfigurationData** *(dict) --* The data of the configuration for a "KNOWLEDGE_BASE" type Amazon Q in Connect Assistant Association. * **contentTagFilter** *(dict) --* An object that can be used to specify Tag conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "tagCondition", "andConditions", "orConditions". 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'} * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **orConditions** *(list) --* A list of conditions which would be applied together with an "OR" condition. * *(dict) --* A list of conditions which would be applied together with an "OR" condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "andConditions", "tagCondition". 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'} * **andConditions** *(list) --* A list of conditions which would be applied together with an "AND" condition. * *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **tagCondition** *(dict) --* A leaf node condition which can be used to specify a tag condition. * **key** *(string) --* The tag key in the tag condition. * **value** *(string) --* The tag value in the tag condition. * **maxResults** *(integer) --* The maximum number of results to return per page. * **overrideKnowledgeBaseSearchType** *(string) --* The search type to be used against the Knowledge Base for this request. The values can be "SEMANTIC" which uses vector embeddings or "HYBRID" which use vector embeddings and raw text * **modifiedTime** *(datetime) --* The time the AI Agent was last modified. * **description** *(string) --* The description of the AI Agent. * **visibilityStatus** *(string) --* The visibility status of the AI Agent. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **origin** *(string) --* Specifies the origin of the AI Agent. "SYSTEM" for a default AI Agent created by Q in Connect or "CUSTOMER" for an AI Agent created by calling AI Agent creation APIs. * **status** *(string) --* The status of the AI Agent. **Exceptions** * "QConnect.Client.exceptions.ConflictException" * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.ServiceQuotaExceededException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException" QConnect / Client / delete_assistant delete_assistant **************** QConnect.Client.delete_assistant(**kwargs) Deletes an assistant. See also: AWS API Documentation **Request Syntax** response = client.delete_assistant( assistantId='string' ) Parameters: **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.UnauthorizedException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" QConnect / Client / list_message_templates list_message_templates ********************** QConnect.Client.list_message_templates(**kwargs) Lists all the available Amazon Q in Connect message templates for the specified knowledge base. See also: AWS API Documentation **Request Syntax** response = client.list_message_templates( nextToken='string', maxResults=123, knowledgeBaseId='string' ) Parameters: * **nextToken** (*string*) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'messageTemplateSummaries': [ { 'messageTemplateArn': 'string', 'messageTemplateId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'name': 'string', 'channelSubtype': 'EMAIL'|'SMS', 'createdTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'lastModifiedBy': 'string', 'activeVersionNumber': 123, 'description': 'string', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **messageTemplateSummaries** *(list) --* Summary information about the message template. * *(dict) --* The summary of the message template. * **messageTemplateArn** *(string) --* The Amazon Resource Name (ARN) of the message template. * **messageTemplateId** *(string) --* The identifier of the message template. * **knowledgeBaseArn** *(string) --* The Amazon Resource Name (ARN) of the knowledge base. * **knowledgeBaseId** *(string) --* The identifier of the knowledge base. * **name** *(string) --* The name of the message template. * **channelSubtype** *(string) --* The channel subtype this message template applies to. * **createdTime** *(datetime) --* The timestamp when the message template was created. * **lastModifiedTime** *(datetime) --* The timestamp when the message template data was last modified. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the message template data. * **activeVersionNumber** *(integer) --* The version number of the message template version that is activated. * **description** *(string) --* The description of the message template. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "QConnect.Client.exceptions.ValidationException" * "QConnect.Client.exceptions.AccessDeniedException" * "QConnect.Client.exceptions.ResourceNotFoundException" * "QConnect.Client.exceptions.ThrottlingException"