2023/11/17 - Amazon Connect Wisdom Service - 10 new 5 updated api methods
Changes This release adds QuickResponse as a new Wisdom resource and Wisdom APIs for import, create, read, search, update and delete QuickResponse resources.
Updates an existing Wisdom quick response.
See also: AWS API Documentation
Request Syntax
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'
)
list
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat .
(string) --
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.
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.
string
The updated description of the quick response.
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) --
boolean
Whether the quick response is active.
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.
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
string
The name of the quick response.
string
[REQUIRED]
The identifier of the quick response.
boolean
Whether to remove the description from the quick response.
boolean
Whether to remove the grouping configuration of the quick response.
boolean
Whether to remove the shortcut key of the quick response.
string
The shortcut key of the quick response. The value should be unique across the knowledge base.
dict
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) --
Retrieves the quick response.
See also: AWS API Documentation
Request Syntax
client.get_quick_response(
knowledgeBaseId='string',
quickResponseId='string'
)
string
[REQUIRED]
The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
string
[REQUIRED]
The identifier of the quick response.
dict
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) --
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
client.start_import_job(
clientToken='string',
externalSourceConfiguration={
'configuration': {
'connectConfiguration': {
'instanceId': 'string'
}
},
'source': 'AMAZON_CONNECT'
},
importJobType='QUICK_RESPONSES',
knowledgeBaseId='string',
metadata={
'string': 'string'
},
uploadId='string'
)
string
The tags used to organize, track, or control access for this resource.
This field is autopopulated if not provided.
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.
string
[REQUIRED]
The type of the import job.
For importing quick response resource, set the value to QUICK_RESPONSES .
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.
dict
The metadata fields of the imported Wisdom resources.
(string) --
(string) --
string
[REQUIRED]
A pointer to the uploaded asset. This value is returned by StartContentUpload.
dict
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.
Creates a Wisdom quick response.
See also: AWS API Documentation
Request Syntax
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'
}
)
list
The Amazon Connect channels this quick response applies to.
(string) --
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.
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.
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.
string
The description of the quick response.
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) --
boolean
Whether the quick response is active.
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.
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
string
[REQUIRED]
The name of the quick response.
string
The shortcut key of the quick response. The value should be unique across the knowledge base.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
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) --
Searches existing Wisdom quick responses in a Wisdom knowledge base.
See also: AWS API Documentation
Request Syntax
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',
]
},
]
}
)
dict
The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
(string) --
(string) --
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.
integer
The maximum number of results to return per page.
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.
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) --
dict
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) --
Lists information about import jobs.
See also: AWS API Documentation
Request Syntax
client.list_import_jobs(
knowledgeBaseId='string',
maxResults=123,
nextToken='string'
)
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.
integer
The maximum number of results to return per page.
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.
dict
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.
Retrieves the started import job.
See also: AWS API Documentation
Request Syntax
client.get_import_job(
importJobId='string',
knowledgeBaseId='string'
)
string
[REQUIRED]
The identifier of the import job to retrieve.
string
[REQUIRED]
The identifier of the knowledge base that the import job belongs to.
dict
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.
Lists information about quick response.
See also: AWS API Documentation
Request Syntax
client.list_quick_responses(
knowledgeBaseId='string',
maxResults=123,
nextToken='string'
)
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.
integer
The maximum number of results to return per page.
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.
dict
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) --
Deletes the quick response import job.
See also: AWS API Documentation
Request Syntax
client.delete_import_job(
importJobId='string',
knowledgeBaseId='string'
)
string
[REQUIRED]
The identifier of the import job to be deleted.
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a quick response.
See also: AWS API Documentation
Request Syntax
client.delete_quick_response(
knowledgeBaseId='string',
quickResponseId='string'
)
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.
string
[REQUIRED]
The identifier of the quick response to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'knowledgeBaseType': {'QUICK_RESPONSES'}}
Response {'knowledgeBase': {'knowledgeBaseType': {'QUICK_RESPONSES'}}}
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
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'
}
)
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.
string
The description.
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.
string
[REQUIRED]
The name of the knowledge base.
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.
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).
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) --
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
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) --
{'knowledgeBase': {'knowledgeBaseType': {'QUICK_RESPONSES'}}}
Retrieves information about the knowledge base.
See also: AWS API Documentation
Request Syntax
client.get_knowledge_base(
knowledgeBaseId='string'
)
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.
dict
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) --
{'knowledgeBaseSummaries': {'knowledgeBaseType': {'QUICK_RESPONSES'}}}
Lists the knowledge bases.
See also: AWS API Documentation
Request Syntax
client.list_knowledge_bases(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return per page.
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.
dict
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.
{'presignedUrlTimeToLive': 'integer'}
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
client.start_content_upload(
contentType='string',
knowledgeBaseId='string',
presignedUrlTimeToLive=123
)
string
[REQUIRED]
The type of content to upload.
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.
integer
The expected expiration time of the generated presigned URL, specified in minutes.
dict
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.
{'knowledgeBase': {'knowledgeBaseType': {'QUICK_RESPONSES'}}}
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
client.update_knowledge_base_template_uri(
knowledgeBaseId='string',
templateUri='string'
)
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.
string
[REQUIRED]
The template URI to update.
dict
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) --