ConnectWisdomService ******************** Client ====== class ConnectWisdomService.Client A low-level client representing Amazon Connect Wisdom Service Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files. import boto3 client = boto3.client('wisdom') These are the available methods: * can_paginate * close * create_assistant * create_assistant_association * create_content * create_knowledge_base * create_quick_response * create_session * delete_assistant * delete_assistant_association * delete_content * delete_import_job * delete_knowledge_base * delete_quick_response * get_assistant * get_assistant_association * get_content * get_content_summary * get_import_job * get_knowledge_base * get_paginator * get_quick_response * get_recommendations * get_session * get_waiter * list_assistant_associations * list_assistants * list_contents * list_import_jobs * list_knowledge_bases * list_quick_responses * list_tags_for_resource * notify_recommendations_received * query_assistant * remove_knowledge_base_template_uri * search_content * search_quick_responses * search_sessions * start_content_upload * start_import_job * tag_resource * untag_resource * update_content * update_knowledge_base_template_uri * update_quick_response 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: * ListAssistantAssociations * ListAssistants * ListContents * ListImportJobs * ListKnowledgeBases * ListQuickResponses * QueryAssistant * SearchContent * SearchQuickResponses * SearchSessions ConnectWisdomService / Paginator / ListContents ListContents ************ class ConnectWisdomService.Paginator.ListContents paginator = client.get_paginator('list_contents') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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 if you're storing Wisdom Content resource to it. 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', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / ListImportJobs ListImportJobs ************** class ConnectWisdomService.Paginator.ListImportJobs paginator = client.get_paginator('list_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. 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': [ { 'createdTime': datetime(2015, 1, 1), 'externalSourceConfiguration': { 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } }, 'source': 'AMAZON_CONNECT' }, 'importJobId': 'string', 'importJobType': 'QUICK_RESPONSES', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'uploadId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **importJobSummaries** *(list) --* Summary information about the import jobs. * *(dict) --* Summary information about the import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **externalSourceConfiguration** *(dict) --* The configuration information of the external source that the resource data are imported from. * **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. * **source** *(string) --* The type of the external data source. * **importJobId** *(string) --* The identifier of the import job. * **importJobType** *(string) --* The type of import job. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedTime** *(datetime) --* The timestamp when the import job was last modified. * **metadata** *(dict) --* The metadata fields of the imported Wisdom resources. * *(string) --* * *(string) --* * **status** *(string) --* The status of the import job. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / SearchSessions SearchSessions ************** class ConnectWisdomService.Paginator.SearchSessions paginator = client.get_paginator('search_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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 Wisdom 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': [ { 'assistantArn': 'string', 'assistantId': 'string', 'sessionArn': 'string', 'sessionId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **sessionSummaries** *(list) --* Summary information about the sessions. * *(dict) --* Summary information about the session. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / ListQuickResponses ListQuickResponses ****************** class ConnectWisdomService.Paginator.ListQuickResponses paginator = client.get_paginator('list_quick_responses') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. 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': [ { 'channels': [ 'string', ], 'contentType': 'string', 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **quickResponseSummaries** *(list) --* Summary information about the quick responses. * *(dict) --* The summary information about the quick response. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **description** *(string) --* The description of the quick response. * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response summary was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **status** *(string) --* The resource status of the quick response. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / SearchContent SearchContent ************* class ConnectWisdomService.Paginator.SearchContent paginator = client.get_paginator('search_content') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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 if you're storing Wisdom Content resource to it. 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', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / QueryAssistant QueryAssistant ************** class ConnectWisdomService.Paginator.QueryAssistant paginator = client.get_paginator('query_assistant') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **queryText** (*string*) -- **[REQUIRED]** The text to search for. * **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': [ { 'document': { 'contentReference': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' }, 'excerpt': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' }, 'title': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' } }, 'relevanceScore': 123.0, 'resultId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the query. * *(dict) --* Information about the result. * **document** *(dict) --* The document. * **contentReference** *(dict) --* A reference to the content resource. * **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 if you're storing Wisdom Content resource to it. * **excerpt** *(dict) --* The excerpt from 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. * **text** *(string) --* Text in the document. * **title** *(dict) --* The title of 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. * **text** *(string) --* Text in the document. * **relevanceScore** *(float) --* The relevance score of the results. * **resultId** *(string) --* The identifier of the result data. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / ListKnowledgeBases ListKnowledgeBases ****************** class ConnectWisdomService.Paginator.ListKnowledgeBases paginator = client.get_paginator('list_knowledge_bases') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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': [ { 'description': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', 'name': 'string', 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] } }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **knowledgeBaseSummaries** *(list) --* Information about the knowledge bases. * *(dict) --* Summary information about the knowledge base. * **description** *(string) --* The description of the knowledge base. * **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 if you're storing Wisdom Content resource to it. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **name** *(string) --* The name of the knowledge base. * **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/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **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". 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 Wisdom. 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) --* * **status** *(string) --* The status of the knowledge base summary. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / ListAssistants ListAssistants ************** class ConnectWisdomService.Paginator.ListAssistants paginator = client.get_paginator('list_assistants') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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': [ { 'assistantArn': 'string', 'assistantId': 'string', 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' }, 'type': 'AGENT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **assistantSummaries** *(list) --* Information about the assistants. * *(dict) --* Summary information about the assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **description** *(string) --* The description of the assistant. * **integrationConfiguration** *(dict) --* The configuration information for the Wisdom assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **name** *(string) --* The name of the assistant. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **status** *(string) --* The status of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **type** *(string) --* The type of the assistant. * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / ListAssistantAssociations ListAssistantAssociations ************************* class ConnectWisdomService.Paginator.ListAssistantAssociations paginator = client.get_paginator('list_assistant_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.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 Wisdom 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': [ { 'assistantArn': 'string', 'assistantAssociationArn': 'string', 'assistantAssociationId': 'string', 'assistantId': 'string', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' } }, 'associationType': 'KNOWLEDGE_BASE', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **assistantAssociationSummaries** *(list) --* Summary information about assistant associations. * *(dict) --* Summary information about the assistant association. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **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. * **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 if you're storing Wisdom Content resource to it. * **associationType** *(string) --* The type of association. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Paginator / SearchQuickResponses SearchQuickResponses ******************** class ConnectWisdomService.Paginator.SearchQuickResponses paginator = client.get_paginator('search_quick_responses') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectWisdomService.Client.search_quick_responses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( attributes={ 'string': 'string' }, knowledgeBaseId='string', searchExpression={ 'filters': [ { 'includeNoExistence': True|False, 'name': 'string', 'operator': 'EQUALS'|'PREFIX', 'values': [ 'string', ] }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' }, 'queries': [ { 'allowFuzziness': True|False, 'name': 'string', 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'priority': 'HIGH'|'MEDIUM'|'LOW', 'values': [ 'string', ] }, ] }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **attributes** (*dict*) -- The user-defined Amazon Connect contact attributes to be resolved when search results are returned. * *(string) --* * *(string) --* * **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. * **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 * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the quick responses by. * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **values** *(list) --* The values of attribute field to filter the quick response by. * *(string) --* * **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. * **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 * **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. * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the quick responses by. * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **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. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the quick responses by. * *(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': [ { 'attributesInterpolated': [ 'string', ], 'attributesNotInterpolated': [ 'string', ], 'channels': [ 'string', ], 'contentType': 'string', 'contents': { 'markdown': { 'content': 'string' }, 'plainText': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'language': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'shortcutKey': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **results** *(list) --* The results of the quick response search. * *(dict) --* The result of quick response search. * **attributesInterpolated** *(list) --* The user defined contact attributes that are resolved when the search result is returned. * *(string) --* * **attributesNotInterpolated** *(list) --* The user defined contact attributes that are not resolved when the search result is returned. * *(string) --* * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **contents** *(dict) --* The contents 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. * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **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 Wisdom 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 Wisdom 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) --* * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **language** *(string) --* The language code value for the language in which the quick response is written. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response search result data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response search result data was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **status** *(string) --* The resource status of the quick response. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. ConnectWisdomService / Client / search_content search_content ************** ConnectWisdomService.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( knowledgeBaseId='string', maxResults=123, nextToken='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] } ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. * **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', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_paginator get_paginator ************* ConnectWisdomService.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. ConnectWisdomService / Client / get_content_summary get_content_summary ******************* ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'contentSummary': { 'contentArn': 'string', 'contentId': 'string', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / update_content update_content ************** ConnectWisdomService.Client.update_content(**kwargs) Updates information about the content. See also: AWS API Documentation **Request Syntax** response = client.update_content( contentId='string', knowledgeBaseId='string', metadata={ 'string': 'string' }, overrideLinkOutUri='string', removeOverrideLinkOutUri=True|False, revisionId='string', title='string', uploadId='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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN * **metadata** (*dict*) -- A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **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. * **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. * **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', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'linkOutUri': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **linkOutUri** *(string) --* The URI 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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.PreconditionFailedExcept ion" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / can_paginate can_paginate ************ ConnectWisdomService.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. ConnectWisdomService / Client / update_knowledge_base_template_uri update_knowledge_base_template_uri ********************************** ConnectWisdomService.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 Wisdom 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/lightning/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 if you're storing Wisdom Content resource to it. 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': { 'description': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', 'lastContentModificationTime': datetime(2015, 1, 1), 'name': 'string', 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] } }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base to update. * **description** *(string) --* The description. * **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 if you're storing Wisdom Content resource to it. * **knowledgeBaseType** *(string) --* The type of 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. * **name** *(string) --* The name of the knowledge base. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **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". 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 Wisdom. 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) --* * **status** *(string) --* The status of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_assistant_associations list_assistant_associations *************************** ConnectWisdomService.Client.list_assistant_associations(**kwargs) Lists information about assistant associations. See also: AWS API Documentation **Request Syntax** response = client.list_assistant_associations( assistantId='string', maxResults=123, nextToken='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'assistantAssociationSummaries': [ { 'assistantArn': 'string', 'assistantAssociationArn': 'string', 'assistantAssociationId': 'string', 'assistantId': 'string', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' } }, 'associationType': 'KNOWLEDGE_BASE', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **assistantAssociationSummaries** *(list) --* Summary information about assistant associations. * *(dict) --* Summary information about the assistant association. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **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. * **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 if you're storing Wisdom Content resource to it. * **associationType** *(string) --* The type of association. * **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** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / update_quick_response update_quick_response ********************* ConnectWisdomService.Client.update_quick_response(**kwargs) Updates an existing Wisdom quick response. See also: AWS API Documentation **Request Syntax** response = client.update_quick_response( channels=[ 'string', ], content={ 'content': 'string' }, contentType='string', description='string', groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] }, isActive=True|False, knowledgeBaseId='string', language='string', name='string', quickResponseId='string', removeDescription=True|False, removeGroupingConfiguration=True|False, removeShortcutKey=True|False, shortcutKey='string' ) Parameters: * **channels** (*list*) -- The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **description** (*string*) -- The updated description of the quick response. * **groupingConfiguration** (*dict*) -- The updated grouping configuration of the quick response. * **criteria** *(string) --* The criteria used for grouping Wisdom 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 Wisdom 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) --* * **isActive** (*boolean*) -- Whether the quick response is active. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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" * **name** (*string*) -- The name of the quick response. * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response. * **removeDescription** (*boolean*) -- Whether to remove the description from the quick response. * **removeGroupingConfiguration** (*boolean*) -- Whether to remove the grouping configuration of the quick response. * **removeShortcutKey** (*boolean*) -- Whether to remove the shortcut key of the quick response. * **shortcutKey** (*string*) -- The shortcut key of the quick response. The value should be unique across the knowledge base. Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'channels': [ 'string', ], 'contentType': 'string', 'contents': { 'markdown': { 'content': 'string' }, 'plainText': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'language': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'shortcutKey': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **contents** *(dict) --* The contents 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. * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **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 Wisdom 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 Wisdom 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) --* * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **language** *(string) --* The language code value for the language in which the quick response is written. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **status** *(string) --* The status of the quick response data. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.PreconditionFailedExcept ion" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / delete_assistant_association delete_assistant_association **************************** ConnectWisdomService.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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_assistant_association create_assistant_association **************************** ConnectWisdomService.Client.create_assistant_association(**kwargs) Creates an association between an Amazon Connect Wisdom 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', association={ 'knowledgeBaseId': 'string' }, associationType='KNOWLEDGE_BASE', clientToken='string', tags={ 'string': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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 if you're storing Wisdom Content resource to it. * **associationType** (*string*) -- **[REQUIRED]** The type of association. * **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': { 'assistantArn': 'string', 'assistantAssociationArn': 'string', 'assistantAssociationId': 'string', 'assistantId': 'string', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' } }, 'associationType': 'KNOWLEDGE_BASE', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **assistantAssociation** *(dict) --* The assistant association. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **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. * **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 if you're storing Wisdom Content resource to it. * **associationType** *(string) --* The type of association. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_session create_session ************** ConnectWisdomService.Client.create_session(**kwargs) Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled. See also: AWS API Documentation **Request Syntax** response = client.create_session( assistantId='string', clientToken='string', description='string', name='string', tags={ 'string': 'string' } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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. * **description** (*string*) -- The description. * **name** (*string*) -- **[REQUIRED]** The name of the session. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'session': { 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'sessionArn': 'string', 'sessionId': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **session** *(dict) --* The session. * **description** *(string) --* The description of the session. * **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. * **name** *(string) --* The name of the session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_tags_for_resource list_tags_for_resource ********************** ConnectWisdomService.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** * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_knowledge_base get_knowledge_base ****************** ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'knowledgeBase': { 'description': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', 'lastContentModificationTime': datetime(2015, 1, 1), 'name': 'string', 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] } }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base. * **description** *(string) --* The description. * **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 if you're storing Wisdom Content resource to it. * **knowledgeBaseType** *(string) --* The type of 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. * **name** *(string) --* The name of the knowledge base. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **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". 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 Wisdom. 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) --* * **status** *(string) --* The status of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_import_jobs list_import_jobs **************** ConnectWisdomService.Client.list_import_jobs(**kwargs) Lists information about import jobs. See also: AWS API Documentation **Request Syntax** response = client.list_import_jobs( knowledgeBaseId='string', maxResults=123, nextToken='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'importJobSummaries': [ { 'createdTime': datetime(2015, 1, 1), 'externalSourceConfiguration': { 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } }, 'source': 'AMAZON_CONNECT' }, 'importJobId': 'string', 'importJobType': 'QUICK_RESPONSES', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'uploadId': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **importJobSummaries** *(list) --* Summary information about the import jobs. * *(dict) --* Summary information about the import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **externalSourceConfiguration** *(dict) --* The configuration information of the external source that the resource data are imported from. * **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. * **source** *(string) --* The type of the external data source. * **importJobId** *(string) --* The identifier of the import job. * **importJobType** *(string) --* The type of import job. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedTime** *(datetime) --* The timestamp when the import job was last modified. * **metadata** *(dict) --* The metadata fields of the imported Wisdom resources. * *(string) --* * *(string) --* * **status** *(string) --* The status of the import job. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **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** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" ConnectWisdomService / Client / get_assistant get_assistant ************* ConnectWisdomService.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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'assistant': { 'assistantArn': 'string', 'assistantId': 'string', 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' }, 'type': 'AGENT' } } **Response Structure** * *(dict) --* * **assistant** *(dict) --* Information about the assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **description** *(string) --* The description. * **integrationConfiguration** *(dict) --* The configuration information for the Wisdom assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **name** *(string) --* The name. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **status** *(string) --* The status of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **type** *(string) --* The type of assistant. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / untag_resource untag_resource ************** ConnectWisdomService.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** * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_quick_response get_quick_response ****************** ConnectWisdomService.Client.get_quick_response(**kwargs) Retrieves the quick response. See also: AWS API Documentation **Request Syntax** response = client.get_quick_response( knowledgeBaseId='string', quickResponseId='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response. Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'channels': [ 'string', ], 'contentType': 'string', 'contents': { 'markdown': { 'content': 'string' }, 'plainText': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'language': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'shortcutKey': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **contents** *(dict) --* The contents 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. * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **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 Wisdom 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 Wisdom 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) --* * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **language** *(string) --* The language code value for the language in which the quick response is written. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **status** *(string) --* The status of the quick response data. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_quick_responses list_quick_responses ******************** ConnectWisdomService.Client.list_quick_responses(**kwargs) Lists information about quick response. See also: AWS API Documentation **Request Syntax** response = client.list_quick_responses( knowledgeBaseId='string', maxResults=123, nextToken='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'quickResponseSummaries': [ { 'channels': [ 'string', ], 'contentType': 'string', 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* * **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. * **quickResponseSummaries** *(list) --* Summary information about the quick responses. * *(dict) --* The summary information about the quick response. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **description** *(string) --* The description of the quick response. * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response summary was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **status** *(string) --* The resource status of the quick response. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_contents list_contents ************* ConnectWisdomService.Client.list_contents(**kwargs) Lists the content. See also: AWS API Documentation **Request Syntax** response = client.list_contents( knowledgeBaseId='string', maxResults=123, nextToken='string' ) Parameters: * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'contentSummaries': [ { 'contentArn': 'string', 'contentId': 'string', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **metadata** *(dict) --* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the revision of the content. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / delete_content delete_content ************** ConnectWisdomService.Client.delete_content(**kwargs) Deletes the content. See also: AWS API Documentation **Request Syntax** response = client.delete_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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / search_quick_responses search_quick_responses ********************** ConnectWisdomService.Client.search_quick_responses(**kwargs) Searches existing Wisdom quick responses in a Wisdom knowledge base. See also: AWS API Documentation **Request Syntax** response = client.search_quick_responses( attributes={ 'string': 'string' }, knowledgeBaseId='string', maxResults=123, nextToken='string', searchExpression={ 'filters': [ { 'includeNoExistence': True|False, 'name': 'string', 'operator': 'EQUALS'|'PREFIX', 'values': [ 'string', ] }, ], 'orderOnField': { 'name': 'string', 'order': 'ASC'|'DESC' }, 'queries': [ { 'allowFuzziness': True|False, 'name': 'string', 'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX', 'priority': 'HIGH'|'MEDIUM'|'LOW', 'values': [ 'string', ] }, ] } ) Parameters: * **attributes** (*dict*) -- The user-defined Amazon Connect contact attributes to be resolved when search results are returned. * *(string) --* * *(string) --* * **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. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. * **searchExpression** (*dict*) -- **[REQUIRED]** The search expression for querying the quick response. * **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 * **includeNoExistence** *(boolean) --* Whether to treat null value as a match for the attribute field. * **name** *(string) --* **[REQUIRED]** The name of the attribute field to filter the quick responses by. * **operator** *(string) --* **[REQUIRED]** The operator to use for filtering. * **values** *(list) --* The values of attribute field to filter the quick response by. * *(string) --* * **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. * **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 * **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. * **name** *(string) --* **[REQUIRED]** The name of the attribute to query the quick responses by. * **operator** *(string) --* **[REQUIRED]** The operator to use for matching attribute field values in the query. * **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. * **values** *(list) --* **[REQUIRED]** The values of the attribute to query the quick responses by. * *(string) --* Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'results': [ { 'attributesInterpolated': [ 'string', ], 'attributesNotInterpolated': [ 'string', ], 'channels': [ 'string', ], 'contentType': 'string', 'contents': { 'markdown': { 'content': 'string' }, 'plainText': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'language': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'shortcutKey': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* * **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. * **results** *(list) --* The results of the quick response search. * *(dict) --* The result of quick response search. * **attributesInterpolated** *(list) --* The user defined contact attributes that are resolved when the search result is returned. * *(string) --* * **attributesNotInterpolated** *(list) --* The user defined contact attributes that are not resolved when the search result is returned. * *(string) --* * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **contents** *(dict) --* The contents 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. * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **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 Wisdom 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 Wisdom 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) --* * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **language** *(string) --* The language code value for the language in which the quick response is written. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response search result data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response search result data was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **status** *(string) --* The resource status of the quick response. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.RequestTimeoutException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_waiter get_waiter ********** ConnectWisdomService.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" ConnectWisdomService / Client / get_import_job get_import_job ************** ConnectWisdomService.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': { 'createdTime': datetime(2015, 1, 1), 'externalSourceConfiguration': { 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } }, 'source': 'AMAZON_CONNECT' }, 'failedRecordReport': 'string', 'importJobId': 'string', 'importJobType': 'QUICK_RESPONSES', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'uploadId': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **importJob** *(dict) --* The import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **externalSourceConfiguration** *(dict) --* The configuration information 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. * **source** *(string) --* The type of the external data source. * **failedRecordReport** *(string) --* The link to donwload the information of resource data that failed to be imported. * **importJobId** *(string) --* The identifier of the import job. * **importJobType** *(string) --* The type of the import job. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedTime** *(datetime) --* The timestamp when the import job data was last modified. * **metadata** *(dict) --* The metadata fields of the imported Wisdom resources. * *(string) --* * *(string) --* * **status** *(string) --* The status of the import job. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **url** *(string) --* The download link to the resource file that is uploaded to the import job. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_content create_content ************** ConnectWisdomService.Client.create_content(**kwargs) Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset. See also: AWS API Documentation **Request Syntax** response = client.create_content( clientToken='string', knowledgeBaseId='string', metadata={ 'string': 'string' }, name='string', overrideLinkOutUri='string', tags={ 'string': 'string' }, title='string', uploadId='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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **metadata** (*dict*) -- A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **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. * **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. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** (*string*) -- The title of the content. If not set, the title is equal to the name. * **uploadId** (*string*) -- **[REQUIRED]** A pointer to the uploaded asset. This value is returned by StartContentUpload. Return type: dict Returns: **Response Syntax** { 'content': { 'contentArn': 'string', 'contentId': 'string', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'linkOutUri': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **linkOutUri** *(string) --* The URI 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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / start_import_job start_import_job **************** ConnectWisdomService.Client.start_import_job(**kwargs) Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. * For importing Wisdom 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( clientToken='string', externalSourceConfiguration={ 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } }, 'source': 'AMAZON_CONNECT' }, importJobType='QUICK_RESPONSES', knowledgeBaseId='string', metadata={ 'string': 'string' }, uploadId='string' ) Parameters: * **clientToken** (*string*) -- The tags used to organize, track, or control access for this resource. This field is autopopulated if not provided. * **externalSourceConfiguration** (*dict*) -- The configuration information of the external source that the resource data are imported from. * **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. * **source** *(string) --* **[REQUIRED]** The type of the external data source. * **importJobType** (*string*) -- **[REQUIRED]** The type of the import job. * For importing quick response resource, set the value to "QUICK_RESPONSES". * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * For importing Wisdom quick responses, this should be a "QUICK_RESPONSES" type knowledge base. * **metadata** (*dict*) -- The metadata fields of the imported Wisdom resources. * *(string) --* * *(string) --* * **uploadId** (*string*) -- **[REQUIRED]** A pointer to the uploaded asset. This value is returned by StartContentUpload. Return type: dict Returns: **Response Syntax** { 'importJob': { 'createdTime': datetime(2015, 1, 1), 'externalSourceConfiguration': { 'configuration': { 'connectConfiguration': { 'instanceId': 'string' } }, 'source': 'AMAZON_CONNECT' }, 'failedRecordReport': 'string', 'importJobId': 'string', 'importJobType': 'QUICK_RESPONSES', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'metadata': { 'string': 'string' }, 'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'uploadId': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **importJob** *(dict) --* The import job. * **createdTime** *(datetime) --* The timestamp when the import job was created. * **externalSourceConfiguration** *(dict) --* The configuration information 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. * **source** *(string) --* The type of the external data source. * **failedRecordReport** *(string) --* The link to donwload the information of resource data that failed to be imported. * **importJobId** *(string) --* The identifier of the import job. * **importJobType** *(string) --* The type of the import job. * **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 if you're storing Wisdom Content resource to it. * **lastModifiedTime** *(datetime) --* The timestamp when the import job data was last modified. * **metadata** *(dict) --* The metadata fields of the imported Wisdom resources. * *(string) --* * *(string) --* * **status** *(string) --* The status of the import job. * **uploadId** *(string) --* A pointer to the uploaded asset. This value is returned by StartContentUpload. * **url** *(string) --* The download link to the resource file that is uploaded to the import job. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_assistant create_assistant **************** ConnectWisdomService.Client.create_assistant(**kwargs) Creates an Amazon Connect Wisdom assistant. See also: AWS API Documentation **Request Syntax** response = client.create_assistant( clientToken='string', description='string', name='string', serverSideEncryptionConfiguration={ 'kmsKeyId': 'string' }, tags={ 'string': 'string' }, type='AGENT' ) 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. * **description** (*string*) -- The description of the assistant. * **name** (*string*) -- **[REQUIRED]** The name of the assistant. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **type** (*string*) -- **[REQUIRED]** The type of assistant. Return type: dict Returns: **Response Syntax** { 'assistant': { 'assistantArn': 'string', 'assistantId': 'string', 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' }, 'type': 'AGENT' } } **Response Structure** * *(dict) --* * **assistant** *(dict) --* Information about the assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **description** *(string) --* The description. * **integrationConfiguration** *(dict) --* The configuration information for the Wisdom assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **name** *(string) --* The name. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **status** *(string) --* The status of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **type** *(string) --* The type of assistant. **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" ConnectWisdomService / Client / notify_recommendations_received notify_recommendations_received ******************************* ConnectWisdomService.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', recommendationIds=[ 'string', ], sessionId='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **recommendationIds** (*list*) -- **[REQUIRED]** The identifiers of the recommendations. * *(string) --* * **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** { 'errors': [ { 'message': 'string', 'recommendationId': 'string' }, ], 'recommendationIds': [ 'string', ] } **Response Structure** * *(dict) --* * **errors** *(list) --* The identifiers of recommendations that are causing errors. * *(dict) --* An error occurred when creating a recommendation. * **message** *(string) --* A recommendation is causing an error. * **recommendationId** *(string) --* The identifier of the recommendation that is in error. * **recommendationIds** *(list) --* The identifiers of the recommendations. * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_assistants list_assistants *************** ConnectWisdomService.Client.list_assistants(**kwargs) Lists information about assistants. See also: AWS API Documentation **Request Syntax** response = client.list_assistants( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'assistantSummaries': [ { 'assistantArn': 'string', 'assistantId': 'string', 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' }, 'type': 'AGENT' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **assistantSummaries** *(list) --* Information about the assistants. * *(dict) --* Summary information about the assistant. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **description** *(string) --* The description of the assistant. * **integrationConfiguration** *(dict) --* The configuration information for the Wisdom assistant integration. * **topicIntegrationArn** *(string) --* The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages. * **name** *(string) --* The name of the assistant. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **status** *(string) --* The status of the assistant. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **type** *(string) --* The type of the assistant. * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" ConnectWisdomService / Client / query_assistant query_assistant *************** ConnectWisdomService.Client.query_assistant(**kwargs) 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', maxResults=123, nextToken='string', queryText='string' ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. * **queryText** (*string*) -- **[REQUIRED]** The text to search for. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'results': [ { 'document': { 'contentReference': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' }, 'excerpt': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' }, 'title': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' } }, 'relevanceScore': 123.0, 'resultId': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **results** *(list) --* The results of the query. * *(dict) --* Information about the result. * **document** *(dict) --* The document. * **contentReference** *(dict) --* A reference to the content resource. * **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 if you're storing Wisdom Content resource to it. * **excerpt** *(dict) --* The excerpt from 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. * **text** *(string) --* Text in the document. * **title** *(dict) --* The title of 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. * **text** *(string) --* Text in the document. * **relevanceScore** *(float) --* The relevance score of the results. * **resultId** *(string) --* The identifier of the result data. **Exceptions** * "ConnectWisdomService.Client.exceptions.RequestTimeoutException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_assistant_association get_assistant_association ************************* ConnectWisdomService.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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'assistantAssociation': { 'assistantArn': 'string', 'assistantAssociationArn': 'string', 'assistantAssociationId': 'string', 'assistantId': 'string', 'associationData': { 'knowledgeBaseAssociation': { 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' } }, 'associationType': 'KNOWLEDGE_BASE', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **assistantAssociation** *(dict) --* The assistant association. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the assistant association. * **assistantAssociationId** *(string) --* The identifier of the assistant association. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **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. * **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 if you're storing Wisdom Content resource to it. * **associationType** *(string) --* The type of association. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_session get_session *********** ConnectWisdomService.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 Wisdom 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': { 'description': 'string', 'integrationConfiguration': { 'topicIntegrationArn': 'string' }, 'name': 'string', 'sessionArn': 'string', 'sessionId': 'string', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **session** *(dict) --* The session. * **description** *(string) --* The description of the session. * **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. * **name** *(string) --* The name of the session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_quick_response create_quick_response ********************* ConnectWisdomService.Client.create_quick_response(**kwargs) Creates a Wisdom quick response. See also: AWS API Documentation **Request Syntax** response = client.create_quick_response( channels=[ 'string', ], clientToken='string', content={ 'content': 'string' }, contentType='string', description='string', groupingConfiguration={ 'criteria': 'string', 'values': [ 'string', ] }, isActive=True|False, knowledgeBaseId='string', language='string', name='string', shortcutKey='string', tags={ 'string': 'string' } ) Parameters: * **channels** (*list*) -- The Amazon Connect channels this quick response applies to. * *(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. * **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. * **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 Wisdom 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 Wisdom 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) --* * **isActive** (*boolean*) -- Whether the quick response is active. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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" * **name** (*string*) -- **[REQUIRED]** The name of the quick response. * **shortcutKey** (*string*) -- The shortcut key of the quick response. The value should be unique across the knowledge base. * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'quickResponse': { 'channels': [ 'string', ], 'contentType': 'string', 'contents': { 'markdown': { 'content': 'string' }, 'plainText': { 'content': 'string' } }, 'createdTime': datetime(2015, 1, 1), 'description': 'string', 'groupingConfiguration': { 'criteria': 'string', 'values': [ 'string', ] }, 'isActive': True|False, 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'language': 'string', 'lastModifiedBy': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'quickResponseArn': 'string', 'quickResponseId': 'string', 'shortcutKey': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **quickResponse** *(dict) --* The quick response. * **channels** *(list) --* The Amazon Connect contact channels this quick response applies to. The supported contact channel types include "Chat". * *(string) --* * **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. * **contents** *(dict) --* The contents 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. * **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. * **createdTime** *(datetime) --* The timestamp when the quick response was created. * **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 Wisdom 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 Wisdom 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) --* * **isActive** *(boolean) --* Whether the quick response is active. * **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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **language** *(string) --* The language code value for the language in which the quick response is written. * **lastModifiedBy** *(string) --* The Amazon Resource Name (ARN) of the user who last updated the quick response data. * **lastModifiedTime** *(datetime) --* The timestamp when the quick response data was last modified. * **name** *(string) --* The name of the quick response. * **quickResponseArn** *(string) --* The Amazon Resource Name (ARN) of the quick response. * **quickResponseId** *(string) --* The identifier of the quick response. * **shortcutKey** *(string) --* The shortcut key of the quick response. The value should be unique across the knowledge base. * **status** *(string) --* The status of the quick response data. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / create_knowledge_base create_knowledge_base ********************* ConnectWisdomService.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', description='string', knowledgeBaseType='EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', name='string', renderingConfiguration={ 'templateUri': 'string' }, serverSideEncryptionConfiguration={ 'kmsKeyId': 'string' }, sourceConfiguration={ 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ '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. * **description** (*string*) -- The description. * **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. * **name** (*string*) -- **[REQUIRED]** The name of the knowledge base. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **sourceConfiguration** (*dict*) -- The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "appIntegrations". * **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 Wisdom. 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) --* * **tags** (*dict*) -- The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'knowledgeBase': { 'description': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', 'lastContentModificationTime': datetime(2015, 1, 1), 'name': 'string', 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] } }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **knowledgeBase** *(dict) --* The knowledge base. * **description** *(string) --* The description. * **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 if you're storing Wisdom Content resource to it. * **knowledgeBaseType** *(string) --* The type of 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. * **name** *(string) --* The name of the knowledge base. * **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", and "kms:Decrypt/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **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". 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 Wisdom. 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) --* * **status** *(string) --* The status of the knowledge base. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.ServiceQuotaExceededExce ption" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" ConnectWisdomService / Client / delete_knowledge_base delete_knowledge_base ********************* ConnectWisdomService.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** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / delete_quick_response delete_quick_response ********************* ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. * **quickResponseId** (*string*) -- **[REQUIRED]** The identifier of the quick response to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / close close ***** ConnectWisdomService.Client.close() Closes underlying endpoint connections. ConnectWisdomService / Client / get_content get_content *********** ConnectWisdomService.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 if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** { 'content': { 'contentArn': 'string', 'contentId': 'string', 'contentType': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'linkOutUri': 'string', 'metadata': { 'string': 'string' }, 'name': 'string', 'revisionId': 'string', 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED', 'tags': { 'string': 'string' }, 'title': '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. * **contentType** *(string) --* The media type 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 if you're storing Wisdom Content resource to it. * **linkOutUri** *(string) --* The URI 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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift. * *(string) --* * *(string) --* * **name** *(string) --* The name of the content. * **revisionId** *(string) --* The identifier of the content revision. * **status** *(string) --* The status of the content. * **tags** *(dict) --* The tags used to organize, track, or control access for this resource. * *(string) --* * *(string) --* * **title** *(string) --* The title of the content. * **url** *(string) --* The URL of the content. * **urlExpiry** *(datetime) --* The expiration time of the URL as an epoch timestamp. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / search_sessions search_sessions *************** ConnectWisdomService.Client.search_sessions(**kwargs) Searches for sessions. See also: AWS API Documentation **Request Syntax** response = client.search_sessions( assistantId='string', maxResults=123, nextToken='string', searchExpression={ 'filters': [ { 'field': 'NAME', 'operator': 'EQUALS', 'value': 'string' }, ] } ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. * **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** { 'nextToken': 'string', 'sessionSummaries': [ { 'assistantArn': 'string', 'assistantId': 'string', 'sessionArn': 'string', 'sessionId': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* If there are additional results, this is the token for the next set of results. * **sessionSummaries** *(list) --* Summary information about the sessions. * *(dict) --* Summary information about the session. * **assistantArn** *(string) --* The Amazon Resource Name (ARN) of the Wisdom assistant. * **assistantId** *(string) --* The identifier of the Wisdom assistant. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the session. * **sessionId** *(string) --* The identifier of the session. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / start_content_upload start_content_upload ******************** ConnectWisdomService.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( contentType='string', knowledgeBaseId='string', presignedUrlTimeToLive=123 ) Parameters: * **contentType** (*string*) -- **[REQUIRED]** The type of content to upload. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. * **presignedUrlTimeToLive** (*integer*) -- The expected expiration time of the generated presigned URL, specified in minutes. Return type: dict Returns: **Response Syntax** { 'headersToInclude': { 'string': 'string' }, 'uploadId': 'string', 'url': 'string', 'urlExpiry': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **headersToInclude** *(dict) --* The headers to include in the upload. * *(string) --* * *(string) --* * **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. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / delete_import_job delete_import_job ***************** ConnectWisdomService.Client.delete_import_job(**kwargs) Deletes the quick response import job. See also: AWS API Documentation **Request Syntax** response = client.delete_import_job( importJobId='string', knowledgeBaseId='string' ) Parameters: * **importJobId** (*string*) -- **[REQUIRED]** The identifier of the import job to be deleted. * **knowledgeBaseId** (*string*) -- **[REQUIRED]** The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ConflictException" * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / remove_knowledge_base_template_uri remove_knowledge_base_template_uri ********************************** ConnectWisdomService.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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / get_recommendations get_recommendations ******************* ConnectWisdomService.Client.get_recommendations(**kwargs) 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', maxResults=123, sessionId='string', waitTimeSeconds=123 ) Parameters: * **assistantId** (*string*) -- **[REQUIRED]** The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **sessionId** (*string*) -- **[REQUIRED]** The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN. * **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. Return type: dict Returns: **Response Syntax** { 'recommendations': [ { 'document': { 'contentReference': { 'contentArn': 'string', 'contentId': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string' }, 'excerpt': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' }, 'title': { 'highlights': [ { 'beginOffsetInclusive': 123, 'endOffsetExclusive': 123 }, ], 'text': 'string' } }, 'recommendationId': 'string', 'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW', 'relevanceScore': 123.0, 'type': 'KNOWLEDGE_CONTENT' }, ], 'triggers': [ { 'data': { 'query': { 'text': 'string' } }, 'id': 'string', 'recommendationIds': [ 'string', ], 'source': 'ISSUE_DETECTION'|'RULE_EVALUATION'|'OTHER', 'type': 'QUERY' }, ] } **Response Structure** * *(dict) --* * **recommendations** *(list) --* The recommendations. * *(dict) --* Information about the recommendation. * **document** *(dict) --* The recommended document. * **contentReference** *(dict) --* A reference to the content resource. * **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 if you're storing Wisdom Content resource to it. * **excerpt** *(dict) --* The excerpt from 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. * **text** *(string) --* Text in the document. * **title** *(dict) --* The title of 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. * **text** *(string) --* Text in the document. * **recommendationId** *(string) --* The identifier of the recommendation. * **relevanceLevel** *(string) --* The relevance level of the recommendation. * **relevanceScore** *(float) --* The relevance score of the recommendation. * **type** *(string) --* The type of recommendation. * **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. * **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. * **id** *(string) --* The identifier of the recommendation trigger. * **recommendationIds** *(list) --* The identifiers of the recommendations. * *(string) --* * **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. * **type** *(string) --* The type of recommendation trigger. **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / list_knowledge_bases list_knowledge_bases ******************** ConnectWisdomService.Client.list_knowledge_bases(**kwargs) Lists the knowledge bases. See also: AWS API Documentation **Request Syntax** response = client.list_knowledge_bases( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return per page. * **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. Return type: dict Returns: **Response Syntax** { 'knowledgeBaseSummaries': [ { 'description': 'string', 'knowledgeBaseArn': 'string', 'knowledgeBaseId': 'string', 'knowledgeBaseType': 'EXTERNAL'|'CUSTOM'|'QUICK_RESPONSES', 'name': 'string', 'renderingConfiguration': { 'templateUri': 'string' }, 'serverSideEncryptionConfiguration': { 'kmsKeyId': 'string' }, 'sourceConfiguration': { 'appIntegrations': { 'appIntegrationArn': 'string', 'objectFields': [ 'string', ] } }, 'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED', 'tags': { 'string': 'string' } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **knowledgeBaseSummaries** *(list) --* Information about the knowledge bases. * *(dict) --* Summary information about the knowledge base. * **description** *(string) --* The description of the knowledge base. * **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 if you're storing Wisdom Content resource to it. * **knowledgeBaseType** *(string) --* The type of knowledge base. * **name** *(string) --* The name of the knowledge base. * **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/kms:GenerateDataKey" permissions to the IAM identity using the key to invoke Wisdom. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. * **kmsKeyId** *(string) --* The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId). * **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". 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 Wisdom. 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) --* * **status** *(string) --* The status of the knowledge base summary. * **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** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" ConnectWisdomService / Client / tag_resource tag_resource ************ ConnectWisdomService.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** * "ConnectWisdomService.Client.exceptions.TooManyTagsException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n" ConnectWisdomService / Client / delete_assistant delete_assistant **************** ConnectWisdomService.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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectWisdomService.Client.exceptions.ValidationException" * "ConnectWisdomService.Client.exceptions.AccessDeniedException" * "ConnectWisdomService.Client.exceptions.ResourceNotFoundExceptio n"