2024/12/03 - QBusiness - 12 new13 updated api methods
Changes Amazon Q Business now supports customization options for your web experience, 11 new Plugins, and QuickSight support. Amazon Q index allows software providers to enrich their native generative AI experiences with their customer's enterprise knowledge and user context spanning multiple applications.
Creates a new data accessor for an ISV to access data from a Q Business application. The data accessor is an entity that represents the ISV's access to the Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an AWS IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Q Business application.
See also: AWS API Documentation
Request Syntax
client.create_data_accessor(
applicationId='string',
principal='string',
actionConfigurations=[
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
clientToken='string',
displayName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
list
[REQUIRED]
A list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) -- [REQUIRED]
The Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) -- [REQUIRED]
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
string
A unique, case-sensitive identifier you provide to ensure idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
A friendly name for the data accessor.
list
The tags to associate with the data accessor.
(dict) --
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
dict
Response Syntax
{
'dataAccessorId': 'string',
'idcApplicationArn': 'string',
'dataAccessorArn': 'string'
}
Response Structure
(dict) --
dataAccessorId (string) --
The unique identifier of the created data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the AWS IAM Identity Center application created for this data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the created data accessor.
Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Q Business application's resources.
See also: AWS API Documentation
Request Syntax
client.associate_permission(
applicationId='string',
statementId='string',
actions=[
'string',
],
principal='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
A unique identifier for the policy statement.
list
[REQUIRED]
The list of Q Business actions that the ISV is allowed to perform.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role for the ISV that is being granted permission.
dict
Response Syntax
{
'statement': 'string'
}
Response Structure
(dict) --
statement (string) --
The JSON representation of the added permission statement.
Lists the data accessors for a Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
See also: AWS API Documentation
Request Syntax
client.list_data_accessors(
applicationId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
The token for the next set of results. (You received this token from a previous call.)
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'dataAccessors': [
{
'displayName': 'string',
'dataAccessorId': 'string',
'dataAccessorArn': 'string',
'idcApplicationArn': 'string',
'principal': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataAccessors (list) --
The list of data accessors.
(dict) --
Provides summary information about a data accessor.
displayName (string) --
The friendly name of the data accessor.
dataAccessorId (string) --
The unique identifier of the data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the associated AWS IAM Identity Center application.
principal (string) --
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
createdAt (datetime) --
The timestamp when the data accessor was created.
updatedAt (datetime) --
The timestamp when the data accessor was last updated.
nextToken (string) --
The token to use to retrieve the next set of results, if there are any.
Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
See also: AWS API Documentation
Request Syntax
client.list_plugin_type_actions(
pluginType='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The type of the plugin.
string
If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.
integer
The maximum number of plugins to return.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'actionIdentifier': 'string',
'displayName': 'string',
'instructionExample': 'string',
'description': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.
items (list) --
An array of information on one or more plugins.
(dict) --
Summary information for an Amazon Q Business plugin action.
actionIdentifier (string) --
The identifier of an Amazon Q Business plugin action.
displayName (string) --
The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.
instructionExample (string) --
An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:
Create a Jira task
Create a chat assistant task to find the root cause of a specific incident
description (string) --
The description of an Amazon Q Business plugin action.
Retrieves the current permission policy for a Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.
See also: AWS API Documentation
Request Syntax
client.get_policy(
applicationId='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
dict
Response Syntax
{
'policy': 'string'
}
Response Structure
(dict) --
policy (string) --
The JSON representation of the permission policy.
Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.list_plugin_actions(
applicationId='string',
pluginId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Q Business application the plugin is attached to.
string
[REQUIRED]
The identifier of the Amazon Q Business plugin.
string
If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.
integer
The maximum number of plugin actions to return.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'actionIdentifier': 'string',
'displayName': 'string',
'instructionExample': 'string',
'description': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.
items (list) --
An array of information on one or more plugin actions.
(dict) --
Summary information for an Amazon Q Business plugin action.
actionIdentifier (string) --
The identifier of an Amazon Q Business plugin action.
displayName (string) --
The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.
instructionExample (string) --
An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:
Create a Jira task
Create a chat assistant task to find the root cause of a specific incident
description (string) --
The description of an Amazon Q Business plugin action.
Lists metadata for all Amazon Q Business plugin types.
See also: AWS API Documentation
Request Syntax
client.list_plugin_type_metadata(
nextToken='string',
maxResults=123
)
string
If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.
integer
The maximum number of plugin metadata items to return.
dict
Response Syntax
{
'nextToken': 'string',
'items': [
{
'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'category': 'Customer relationship management (CRM)'|'Project management'|'Communication'|'Productivity'|'Ticketing and incident management',
'description': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.
items (list) --
An array of information on plugin metadata.
(dict) --
Summary metadata information for a Amazon Q Business plugin.
type (string) --
The type of the plugin.
category (string) --
The category of the plugin type.
description (string) --
The description assigned by Amazon Q Business to a plugin. You can't modify this value.
Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
See also: AWS API Documentation
Request Syntax
client.update_data_accessor(
applicationId='string',
dataAccessorId='string',
actionConfigurations=[
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
displayName='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
The unique identifier of the data accessor to update.
list
[REQUIRED]
The updated list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) -- [REQUIRED]
The Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) -- [REQUIRED]
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
string
The updated friendly name for the data accessor.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a specified data accessor. This operation permanently removes the data accessor and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked
See also: AWS API Documentation
Request Syntax
client.delete_data_accessor(
applicationId='string',
dataAccessorId='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
The unique identifier of the data accessor to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as user ID, user groups, content source, and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.
See also: AWS API Documentation
Request Syntax
client.search_relevant_content(
applicationId='string',
userId='string',
userGroups=[
'string',
],
queryText='string',
contentSource={
'retriever': {
'retrieverId': 'string'
}
},
attributeFilter={
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
},
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application to search.
string
The ID of the user performing the search. Used for access control.
list
The groups the user belongs to. Used for access control.
(string) --
string
[REQUIRED]
The text to search for.
dict
[REQUIRED]
The source of content to search in.
retriever (dict) --
The retriever to use as the content source.
retrieverId (string) -- [REQUIRED]
The unique identifier of the retriever to use as the content source.
dict
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
integer
The maximum number of results to return.
string
The token for the next set of results. (You received this token from a previous call.)
dict
Response Syntax
{
'relevantContent': [
{
'content': 'string',
'documentId': 'string',
'documentTitle': 'string',
'documentUri': 'string',
'documentAttributes': [
{
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
],
'scoreAttributes': {
'scoreConfidence': 'VERY_HIGH'|'HIGH'|'MEDIUM'|'LOW'|'NOT_AVAILABLE'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
relevantContent (list) --
The list of relevant content items found.
(dict) --
Represents a piece of content that is relevant to a search query.
content (string) --
The actual content of the relevant item.
documentId (string) --
The unique identifier of the document containing the relevant content.
documentTitle (string) --
The title of the document containing the relevant content.
documentUri (string) --
The URI of the document containing the relevant content.
documentAttributes (list) --
Additional attributes of the document containing the relevant content.
(dict) --
A document attribute or metadata field.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
scoreAttributes (dict) --
Attributes related to the relevance score of the content.
scoreConfidence (string) --
The confidence level of the relevance score.
nextToken (string) --
The token to use to retrieve the next set of results, if there are any.
Removes a permission policy from a Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.
See also: AWS API Documentation
Request Syntax
client.disassociate_permission(
applicationId='string',
statementId='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
The statement ID of the permission to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Q Business application and AWS IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
See also: AWS API Documentation
Request Syntax
client.get_data_accessor(
applicationId='string',
dataAccessorId='string'
)
string
[REQUIRED]
The unique identifier of the Q Business application.
string
[REQUIRED]
The unique identifier of the data accessor to retrieve.
dict
Response Syntax
{
'displayName': 'string',
'dataAccessorId': 'string',
'dataAccessorArn': 'string',
'applicationId': 'string',
'idcApplicationArn': 'string',
'principal': 'string',
'actionConfigurations': [
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
displayName (string) --
The friendly name of the data accessor.
dataAccessorId (string) --
The unique identifier of the data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the data accessor.
applicationId (string) --
The unique identifier of the Q Business application associated with this data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the AWS IAM Identity Center application associated with this data accessor.
principal (string) --
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
actionConfigurations (list) --
The list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) --
The Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) --
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
createdAt (datetime) --
The timestamp when the data accessor was created.
updatedAt (datetime) --
The timestamp when the data accessor was last updated.
{'outputStream': {'actionReviewEvent': {'pluginType': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}}}
Starts or continues a streaming Amazon Q Business conversation.
See also: AWS API Documentation
Request Syntax
client.chat(
applicationId='string',
userId='string',
userGroups=[
'string',
],
conversationId='string',
parentMessageId='string',
clientToken='string',
inputStream={...}
)
string
[REQUIRED]
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
string
The identifier of the user attached to the chat input.
list
The group names that a user associated with the chat input belongs to.
(string) --
string
The identifier of the Amazon Q Business conversation.
string
The identifier used to associate a user message with a AI generated response.
string
A token that you provide to identify the chat input.
This field is autopopulated if not provided.
dict
The streaming input for the Chat API.
dict
The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.
Response Syntax
{
'outputStream': EventStream({
'textEvent': {
'conversationId': 'string',
'userMessageId': 'string',
'systemMessageId': 'string',
'systemMessage': 'string'
},
'metadataEvent': {
'conversationId': 'string',
'userMessageId': 'string',
'systemMessageId': 'string',
'sourceAttributions': [
{
'title': 'string',
'snippet': 'string',
'url': 'string',
'citationNumber': 123,
'updatedAt': datetime(2015, 1, 1),
'textMessageSegments': [
{
'beginOffset': 123,
'endOffset': 123,
'snippetExcerpt': {
'text': 'string'
},
'mediaId': 'string',
'mediaMimeType': 'string'
},
]
},
],
'finalTextMessage': 'string'
},
'actionReviewEvent': {
'conversationId': 'string',
'userMessageId': 'string',
'systemMessageId': 'string',
'pluginId': 'string',
'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'payload': {
'string': {
'displayName': 'string',
'displayOrder': 123,
'displayDescription': 'string',
'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN',
'value': {...}|[...]|123|123.4|'string'|True|None,
'allowedValues': [
{
'value': {...}|[...]|123|123.4|'string'|True|None,
'displayValue': {...}|[...]|123|123.4|'string'|True|None
},
],
'allowedFormat': 'string',
'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None,
'required': True|False
}
},
'payloadFieldNameSeparator': 'string'
},
'failedAttachmentEvent': {
'conversationId': 'string',
'userMessageId': 'string',
'systemMessageId': 'string',
'attachment': {
'name': 'string',
'status': 'FAILED'|'SUCCESS',
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'attachmentId': 'string',
'conversationId': 'string'
}
},
'authChallengeRequestEvent': {
'authorizationUrl': 'string'
}
})
}
Response Structure
(dict) --
outputStream (:class:`.EventStream`) --
The streaming output for the Chat API.
textEvent (dict) --
Information about the payload of the ChatOutputStream event containing the AI-generated message output.
conversationId (string) --
The identifier of the conversation with which the text output event is associated.
userMessageId (string) --
The identifier of an end user message in a TextOutputEvent.
systemMessageId (string) --
The identifier of an AI-generated message in a TextOutputEvent.
systemMessage (string) --
An AI-generated message in a TextOutputEvent.
metadataEvent (dict) --
A metadata event for a AI-generated text output message in a Amazon Q Business conversation.
conversationId (string) --
The identifier of the conversation with which the generated metadata is associated.
userMessageId (string) --
The identifier of an Amazon Q Business end user text input message within the conversation.
systemMessageId (string) --
The identifier of an Amazon Q Business AI generated message within the conversation.
sourceAttributions (list) --
The source documents used to generate the conversation response.
(dict) --
The documents used to generate an Amazon Q Business web experience response.
title (string) --
The title of the document which is the source for the Amazon Q Business generated response.
snippet (string) --
The content extract from the document on which the generated response is based.
url (string) --
The URL of the document which is the source for the Amazon Q Business generated response.
citationNumber (integer) --
The number attached to a citation in an Amazon Q Business generated response.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
textMessageSegments (list) --
A text extract from a source document that is used for source attribution.
(dict) --
Provides information about a text extract in a chat response that can be attributed to a source document.
beginOffset (integer) --
The zero-based location in the response string where the source attribution starts.
endOffset (integer) --
The zero-based location in the response string where the source attribution ends.
snippetExcerpt (dict) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
text (string) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
mediaId (string) --
The identifier of the media object associated with the text segment in the source attribution.
mediaMimeType (string) --
The MIME type (image/png) of the media object associated with the text segment in the source attribution.
finalTextMessage (string) --
The final text output message generated by the system.
actionReviewEvent (dict) --
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
conversationId (string) --
The identifier of the conversation with which the action review event is associated.
userMessageId (string) --
The identifier of the conversation with which the plugin action is associated.
systemMessageId (string) --
The identifier of an Amazon Q Business AI generated associated with the action review event.
pluginId (string) --
The identifier of the plugin associated with the action review event.
pluginType (string) --
The type of plugin.
payload (dict) --
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(string) --
(dict) --
A user input field in an plugin action review payload.
displayName (string) --
The name of the field.
displayOrder (integer) --
The display order of fields in a payload.
displayDescription (string) --
The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
type (string) --
The type of field.
value (:ref:`document<document>`) --
The field value.
allowedValues (list) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(dict) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
value (:ref:`document<document>`) --
The field value.
displayValue (:ref:`document<document>`) --
The name of the field.
allowedFormat (string) --
The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.
arrayItemJsonSchema (:ref:`document<document>`) --
Use to create a custom form with array fields (fields with nested objects inside an array).
required (boolean) --
Information about whether the field is required.
payloadFieldNameSeparator (string) --
A string used to retain information about the hierarchical contexts within an action review event payload.
failedAttachmentEvent (dict) --
A failed file upload event during a web experience chat.
conversationId (string) --
The identifier of the conversation associated with the failed file upload.
userMessageId (string) --
The identifier of the end user chat message associated with the file upload.
systemMessageId (string) --
The identifier of the AI-generated message associated with the file upload.
attachment (dict) --
The details of a file uploaded during chat.
name (string) --
The name of a file uploaded during chat.
status (string) --
The status of a file uploaded during chat.
error (dict) --
An error associated with a file uploaded during chat.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
attachmentId (string) --
The unique identifier of the Amazon Q Business attachment.
conversationId (string) --
The unique identifier of the Amazon Q Business conversation.
authChallengeRequestEvent (dict) --
An authentication verification event activated by an end user request to use a custom plugin.
authorizationUrl (string) --
The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.
{'actionReview': {'pluginType': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}}
Starts or continues a non-streaming Amazon Q Business conversation.
See also: AWS API Documentation
Request Syntax
client.chat_sync(
applicationId='string',
userId='string',
userGroups=[
'string',
],
userMessage='string',
attachments=[
{
'data': b'bytes',
'name': 'string',
'copyFrom': {
'conversation': {
'conversationId': 'string',
'attachmentId': 'string'
}
}
},
],
actionExecution={
'pluginId': 'string',
'payload': {
'string': {
'value': {...}|[...]|123|123.4|'string'|True|None
}
},
'payloadFieldNameSeparator': 'string'
},
authChallengeResponse={
'responseMap': {
'string': 'string'
}
},
conversationId='string',
parentMessageId='string',
attributeFilter={
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
},
chatMode='RETRIEVAL_MODE'|'CREATOR_MODE'|'PLUGIN_MODE',
chatModeConfiguration={
'pluginConfiguration': {
'pluginId': 'string'
}
},
clientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
string
The identifier of the user attached to the chat input.
list
The group names that a user associated with the chat input belongs to.
(string) --
string
A end user message in a conversation.
list
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
(dict) --
This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat.
data (bytes) --
The contents of the attachment.
name (string) --
The filename of the attachment.
copyFrom (dict) --
A reference to an existing attachment.
conversation (dict) --
A reference to an attachment in an existing conversation.
conversationId (string) -- [REQUIRED]
The unique identifier of the Amazon Q Business conversation.
attachmentId (string) -- [REQUIRED]
The unique identifier of the Amazon Q Business attachment.
dict
A request from an end user to perform an Amazon Q Business plugin action.
pluginId (string) -- [REQUIRED]
The identifier of the plugin the action is attached to.
payload (dict) -- [REQUIRED]
A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
(string) --
(dict) --
A user input field in an plugin action execution payload.
value (:ref:`document<document>`) -- [REQUIRED]
The content of a user input field in an plugin action execution payload.
payloadFieldNameSeparator (string) -- [REQUIRED]
A string used to retain information about the hierarchical contexts within an action execution event payload.
dict
An authentication verification event response by a third party authentication server to Amazon Q Business.
responseMap (dict) -- [REQUIRED]
The mapping of key-value pairs in an authentication challenge response.
(string) --
(string) --
string
The identifier of the Amazon Q Business conversation.
string
The identifier of the previous system message in a conversation.
dict
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
string
The chatMode parameter determines the chat modes available to Amazon Q Business users:
RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge
CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.
PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.
For more information, see Admin controls and guardrails, Plugins, and Response sources.
dict
The chat mode configuration for an Amazon Q Business application.
pluginConfiguration (dict) --
Configuration information required to invoke chat in PLUGIN_MODE.
pluginId (string) -- [REQUIRED]
The identifier of the plugin you want to use.
string
A token that you provide to identify a chat request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'conversationId': 'string',
'systemMessage': 'string',
'systemMessageId': 'string',
'userMessageId': 'string',
'actionReview': {
'pluginId': 'string',
'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'payload': {
'string': {
'displayName': 'string',
'displayOrder': 123,
'displayDescription': 'string',
'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN',
'value': {...}|[...]|123|123.4|'string'|True|None,
'allowedValues': [
{
'value': {...}|[...]|123|123.4|'string'|True|None,
'displayValue': {...}|[...]|123|123.4|'string'|True|None
},
],
'allowedFormat': 'string',
'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None,
'required': True|False
}
},
'payloadFieldNameSeparator': 'string'
},
'authChallengeRequest': {
'authorizationUrl': 'string'
},
'sourceAttributions': [
{
'title': 'string',
'snippet': 'string',
'url': 'string',
'citationNumber': 123,
'updatedAt': datetime(2015, 1, 1),
'textMessageSegments': [
{
'beginOffset': 123,
'endOffset': 123,
'snippetExcerpt': {
'text': 'string'
},
'mediaId': 'string',
'mediaMimeType': 'string'
},
]
},
],
'failedAttachments': [
{
'name': 'string',
'status': 'FAILED'|'SUCCESS',
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'attachmentId': 'string',
'conversationId': 'string'
},
]
}
Response Structure
(dict) --
conversationId (string) --
The identifier of the Amazon Q Business conversation.
systemMessage (string) --
An AI-generated message in a conversation.
systemMessageId (string) --
The identifier of an Amazon Q Business AI generated message within the conversation.
userMessageId (string) --
The identifier of an Amazon Q Business end user text input message within the conversation.
actionReview (dict) --
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
pluginId (string) --
The identifier of the plugin associated with the action review.
pluginType (string) --
The type of plugin.
payload (dict) --
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(string) --
(dict) --
A user input field in an plugin action review payload.
displayName (string) --
The name of the field.
displayOrder (integer) --
The display order of fields in a payload.
displayDescription (string) --
The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
type (string) --
The type of field.
value (:ref:`document<document>`) --
The field value.
allowedValues (list) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(dict) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
value (:ref:`document<document>`) --
The field value.
displayValue (:ref:`document<document>`) --
The name of the field.
allowedFormat (string) --
The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.
arrayItemJsonSchema (:ref:`document<document>`) --
Use to create a custom form with array fields (fields with nested objects inside an array).
required (boolean) --
Information about whether the field is required.
payloadFieldNameSeparator (string) --
A string used to retain information about the hierarchical contexts within an action review payload.
authChallengeRequest (dict) --
An authentication verification event activated by an end user request to use a custom plugin.
authorizationUrl (string) --
The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
sourceAttributions (list) --
The source documents used to generate the conversation response.
(dict) --
The documents used to generate an Amazon Q Business web experience response.
title (string) --
The title of the document which is the source for the Amazon Q Business generated response.
snippet (string) --
The content extract from the document on which the generated response is based.
url (string) --
The URL of the document which is the source for the Amazon Q Business generated response.
citationNumber (integer) --
The number attached to a citation in an Amazon Q Business generated response.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
textMessageSegments (list) --
A text extract from a source document that is used for source attribution.
(dict) --
Provides information about a text extract in a chat response that can be attributed to a source document.
beginOffset (integer) --
The zero-based location in the response string where the source attribution starts.
endOffset (integer) --
The zero-based location in the response string where the source attribution ends.
snippetExcerpt (dict) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
text (string) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
mediaId (string) --
The identifier of the media object associated with the text segment in the source attribution.
mediaMimeType (string) --
The MIME type (image/png) of the media object associated with the text segment in the source attribution.
failedAttachments (list) --
A list of files which failed to upload during chat.
(dict) --
The details of a file uploaded during chat.
name (string) --
The name of a file uploaded during chat.
status (string) --
The status of a file uploaded during chat.
error (dict) --
An error associated with a file uploaded during chat.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
attachmentId (string) --
The unique identifier of the Amazon Q Business attachment.
conversationId (string) --
The unique identifier of the Amazon Q Business conversation.
{'identityType': {'AWS_QUICKSIGHT_IDP'},
'quickSightConfiguration': {'clientNamespace': 'string'}}
Creates an Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.create_application(
displayName='string',
roleArn='string',
identityType='AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP',
iamIdentityProviderArn='string',
identityCenterInstanceArn='string',
clientIdsForOIDC=[
'string',
],
description='string',
encryptionConfiguration={
'kmsKeyId': 'string'
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
clientToken='string',
attachmentsConfiguration={
'attachmentsControlMode': 'ENABLED'|'DISABLED'
},
qAppsConfiguration={
'qAppsControlMode': 'ENABLED'|'DISABLED'
},
personalizationConfiguration={
'personalizationControlMode': 'ENABLED'|'DISABLED'
},
quickSightConfiguration={
'clientNamespace': 'string'
}
)
string
[REQUIRED]
A name for the Amazon Q Business application.
string
The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
string
The authentication type being used by a Amazon Q Business application.
string
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
string
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
list
The OIDC client ID for a Amazon Q Business application.
(string) --
string
A description for the Amazon Q Business application.
dict
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
kmsKeyId (string) --
The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
list
A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
(dict) --
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
string
A token that you provide to identify the request to create your Amazon Q Business application.
This field is autopopulated if not provided.
dict
An option to allow end users to upload files directly during chat.
attachmentsControlMode (string) -- [REQUIRED]
Status information about whether file upload functionality is activated or deactivated for your end user.
dict
An option to allow end users to create and use Amazon Q Apps in the web experience.
qAppsControlMode (string) -- [REQUIRED]
Status information about whether end users can create and use Amazon Q Apps in the web experience.
dict
Configuration information about chat response personalization. For more information, see Personalizing chat responses
personalizationControlMode (string) -- [REQUIRED]
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
dict
The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.
clientNamespace (string) -- [REQUIRED]
The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.
dict
Response Syntax
{
'applicationId': 'string',
'applicationArn': 'string'
}
Response Structure
(dict) --
applicationId (string) --
The identifier of the Amazon Q Business application.
applicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
{'authConfiguration': {'idcAuthConfiguration': {'idcApplicationArn': 'string',
'roleArn': 'string'},
'oAuth2ClientCredentialConfiguration': {'authorizationUrl': 'string',
'tokenUrl': 'string'}},
'type': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}
Creates an Amazon Q Business plugin.
See also: AWS API Documentation
Request Syntax
client.create_plugin(
applicationId='string',
displayName='string',
type='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
authConfiguration={
'basicAuthConfiguration': {
'secretArn': 'string',
'roleArn': 'string'
},
'oAuth2ClientCredentialConfiguration': {
'secretArn': 'string',
'roleArn': 'string',
'authorizationUrl': 'string',
'tokenUrl': 'string'
},
'noAuthConfiguration': {}
,
'idcAuthConfiguration': {
'idcApplicationArn': 'string',
'roleArn': 'string'
}
},
serverUrl='string',
customPluginConfiguration={
'description': 'string',
'apiSchemaType': 'OPEN_API_V3',
'apiSchema': {
'payload': 'string',
's3': {
'bucket': 'string',
'key': 'string'
}
}
},
tags=[
{
'key': 'string',
'value': 'string'
},
],
clientToken='string'
)
string
[REQUIRED]
The identifier of the application that will contain the plugin.
string
[REQUIRED]
A the name for your plugin.
string
[REQUIRED]
The type of plugin you want to create.
dict
[REQUIRED]
Authentication configuration information for an Amazon Q Business plugin.
basicAuthConfiguration (dict) --
Information about the basic authentication credentials used to configure a plugin.
secretArn (string) -- [REQUIRED]
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn (string) -- [REQUIRED]
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
oAuth2ClientCredentialConfiguration (dict) --
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn (string) -- [REQUIRED]
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn (string) -- [REQUIRED]
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
authorizationUrl (string) --
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
tokenUrl (string) --
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
noAuthConfiguration (dict) --
Information about invoking a custom plugin without any authentication.
idcAuthConfiguration (dict) --
Information about the IAM Identity Center Application used to configure authentication for a plugin.
idcApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
string
The source URL used for plugin configuration.
dict
Contains configuration for a custom plugin.
description (string) -- [REQUIRED]
A description for your custom plugin configuration.
apiSchemaType (string) -- [REQUIRED]
The type of OpenAPI schema to use.
apiSchema (dict) -- [REQUIRED]
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
payload (string) --
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3 (dict) --
Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
bucket (string) -- [REQUIRED]
The name of the S3 bucket that contains the file.
key (string) -- [REQUIRED]
The name of the file.
list
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
(dict) --
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
string
A token that you provide to identify the request to create your Amazon Q Business plugin.
This field is autopopulated if not provided.
dict
Response Syntax
{
'pluginId': 'string',
'pluginArn': 'string',
'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'
}
Response Structure
(dict) --
pluginId (string) --
The identifier of the plugin created.
pluginArn (string) --
The Amazon Resource Name (ARN) of a plugin.
buildStatus (string) --
The current status of a plugin. A plugin is modified asynchronously.
{'customizationConfiguration': {'customCSSUrl': 'string',
'faviconUrl': 'string',
'fontUrl': 'string',
'logoUrl': 'string'}}
Creates an Amazon Q Business web experience.
See also: AWS API Documentation
Request Syntax
client.create_web_experience(
applicationId='string',
title='string',
subtitle='string',
welcomeMessage='string',
samplePromptsControlMode='ENABLED'|'DISABLED',
origins=[
'string',
],
roleArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
clientToken='string',
identityProviderConfiguration={
'samlConfiguration': {
'authenticationUrl': 'string'
},
'openIDConnectConfiguration': {
'secretsArn': 'string',
'secretsRole': 'string'
}
},
browserExtensionConfiguration={
'enabledBrowserExtensions': [
'FIREFOX'|'CHROME',
]
},
customizationConfiguration={
'customCSSUrl': 'string',
'logoUrl': 'string',
'fontUrl': 'string',
'faviconUrl': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Q Business web experience.
string
The title for your Amazon Q Business web experience.
string
A subtitle to personalize your Amazon Q Business web experience.
string
The customized welcome message for end users of an Amazon Q Business web experience.
string
Determines whether sample prompts are enabled in the web experience for an end user.
list
Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> <note> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </note>
(string) --
string
The Amazon Resource Name (ARN) of the service role attached to your web experience.
list
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
(dict) --
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
string
A token you provide to identify a request to create an Amazon Q Business web experience.
This field is autopopulated if not provided.
dict
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
samlConfiguration (dict) --
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
authenticationUrl (string) -- [REQUIRED]
The URL where Amazon Q Business end users will be redirected for authentication.
openIDConnectConfiguration (dict) --
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
secretsArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
secretsRole (string) -- [REQUIRED]
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
dict
The browser extension configuration for an Amazon Q Business web experience.
enabledBrowserExtensions (list) -- [REQUIRED]
Specify the browser extensions allowed for your Amazon Q web experience.
CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
FIREFOX — Enables the extension for Mozilla Firefox.
CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
(string) --
dict
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
customCSSUrl (string) --
Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
logoUrl (string) --
Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
fontUrl (string) --
Provides the URL where the custom font file is hosted for an Amazon Q web experience.
faviconUrl (string) --
Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
dict
Response Syntax
{
'webExperienceId': 'string',
'webExperienceArn': 'string'
}
Response Structure
(dict) --
webExperienceId (string) --
The identifier of the Amazon Q Business web experience.
webExperienceArn (string) --
The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
{'identityType': {'AWS_QUICKSIGHT_IDP'},
'quickSightConfiguration': {'clientNamespace': 'string'}}
Gets information about an existing Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.get_application(
applicationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Q Business application.
dict
Response Syntax
{
'displayName': 'string',
'applicationId': 'string',
'applicationArn': 'string',
'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP',
'iamIdentityProviderArn': 'string',
'identityCenterApplicationArn': 'string',
'roleArn': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'description': 'string',
'encryptionConfiguration': {
'kmsKeyId': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'attachmentsConfiguration': {
'attachmentsControlMode': 'ENABLED'|'DISABLED'
},
'qAppsConfiguration': {
'qAppsControlMode': 'ENABLED'|'DISABLED'
},
'personalizationConfiguration': {
'personalizationControlMode': 'ENABLED'|'DISABLED'
},
'autoSubscriptionConfiguration': {
'autoSubscribe': 'ENABLED'|'DISABLED',
'defaultSubscriptionType': 'Q_LITE'|'Q_BUSINESS'
},
'clientIdsForOIDC': [
'string',
],
'quickSightConfiguration': {
'clientNamespace': 'string'
}
}
Response Structure
(dict) --
displayName (string) --
The name of the Amazon Q Business application.
applicationId (string) --
The identifier of the Amazon Q Business application.
applicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
identityType (string) --
The authentication type being used by a Amazon Q Business application.
iamIdentityProviderArn (string) --
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
identityCenterApplicationArn (string) --
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
status (string) --
The status of the Amazon Q Business application.
description (string) --
A description for the Amazon Q Business application.
encryptionConfiguration (dict) --
The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
kmsKeyId (string) --
The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
createdAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
error (dict) --
If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
attachmentsConfiguration (dict) --
Settings for whether end users can upload files directly during chat.
attachmentsControlMode (string) --
Information about whether file upload during chat functionality is activated for your application.
qAppsConfiguration (dict) --
Settings for whether end users can create and use Amazon Q Apps in the web experience.
qAppsControlMode (string) --
Status information about whether end users can create and use Amazon Q Apps in the web experience.
personalizationConfiguration (dict) --
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
personalizationControlMode (string) --
An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
autoSubscriptionConfiguration (dict) --
Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
autoSubscribe (string) --
Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
defaultSubscriptionType (string) --
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
clientIdsForOIDC (list) --
The OIDC client ID for a Amazon Q Business application.
(string) --
quickSightConfiguration (dict) --
The Amazon QuickSight authentication configuration for the Amazon Q Business application.
clientNamespace (string) --
The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.
{'authConfiguration': {'idcAuthConfiguration': {'idcApplicationArn': 'string',
'roleArn': 'string'},
'oAuth2ClientCredentialConfiguration': {'authorizationUrl': 'string',
'tokenUrl': 'string'}},
'type': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}
Gets information about an existing Amazon Q Business plugin.
See also: AWS API Documentation
Request Syntax
client.get_plugin(
applicationId='string',
pluginId='string'
)
string
[REQUIRED]
The identifier of the application which contains the plugin.
string
[REQUIRED]
The identifier of the plugin.
dict
Response Syntax
{
'applicationId': 'string',
'pluginId': 'string',
'displayName': 'string',
'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'serverUrl': 'string',
'authConfiguration': {
'basicAuthConfiguration': {
'secretArn': 'string',
'roleArn': 'string'
},
'oAuth2ClientCredentialConfiguration': {
'secretArn': 'string',
'roleArn': 'string',
'authorizationUrl': 'string',
'tokenUrl': 'string'
},
'noAuthConfiguration': {},
'idcAuthConfiguration': {
'idcApplicationArn': 'string',
'roleArn': 'string'
}
},
'customPluginConfiguration': {
'description': 'string',
'apiSchemaType': 'OPEN_API_V3',
'apiSchema': {
'payload': 'string',
's3': {
'bucket': 'string',
'key': 'string'
}
}
},
'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'pluginArn': 'string',
'state': 'ENABLED'|'DISABLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
applicationId (string) --
The identifier of the application which contains the plugin.
pluginId (string) --
The identifier of the plugin.
displayName (string) --
The name of the plugin.
type (string) --
The type of the plugin.
serverUrl (string) --
The source URL used for plugin configuration.
authConfiguration (dict) --
Authentication configuration information for an Amazon Q Business plugin.
basicAuthConfiguration (dict) --
Information about the basic authentication credentials used to configure a plugin.
secretArn (string) --
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn (string) --
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
oAuth2ClientCredentialConfiguration (dict) --
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn (string) --
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn (string) --
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
authorizationUrl (string) --
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
tokenUrl (string) --
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
noAuthConfiguration (dict) --
Information about invoking a custom plugin without any authentication.
idcAuthConfiguration (dict) --
Information about the IAM Identity Center Application used to configure authentication for a plugin.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
customPluginConfiguration (dict) --
Configuration information required to create a custom plugin.
description (string) --
A description for your custom plugin configuration.
apiSchemaType (string) --
The type of OpenAPI schema to use.
apiSchema (dict) --
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
payload (string) --
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3 (dict) --
Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
bucket (string) --
The name of the S3 bucket that contains the file.
key (string) --
The name of the file.
buildStatus (string) --
The current status of a plugin. A plugin is modified asynchronously.
pluginArn (string) --
The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
state (string) --
The current state of the plugin.
createdAt (datetime) --
The timestamp for when the plugin was created.
updatedAt (datetime) --
The timestamp for when the plugin was last updated.
{'customizationConfiguration': {'customCSSUrl': 'string',
'faviconUrl': 'string',
'fontUrl': 'string',
'logoUrl': 'string'}}
Gets information about an existing Amazon Q Business web experience.
See also: AWS API Documentation
Request Syntax
client.get_web_experience(
applicationId='string',
webExperienceId='string'
)
string
[REQUIRED]
The identifier of the Amazon Q Business application linked to the web experience.
string
[REQUIRED]
The identifier of the Amazon Q Business web experience.
dict
Response Syntax
{
'applicationId': 'string',
'webExperienceId': 'string',
'webExperienceArn': 'string',
'defaultEndpoint': 'string',
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'PENDING_AUTH_CONFIG',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'title': 'string',
'subtitle': 'string',
'welcomeMessage': 'string',
'samplePromptsControlMode': 'ENABLED'|'DISABLED',
'origins': [
'string',
],
'roleArn': 'string',
'identityProviderConfiguration': {
'samlConfiguration': {
'authenticationUrl': 'string'
},
'openIDConnectConfiguration': {
'secretsArn': 'string',
'secretsRole': 'string'
}
},
'authenticationConfiguration': {
'samlConfiguration': {
'metadataXML': 'string',
'roleArn': 'string',
'userIdAttribute': 'string',
'userGroupAttribute': 'string'
}
},
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'browserExtensionConfiguration': {
'enabledBrowserExtensions': [
'FIREFOX'|'CHROME',
]
},
'customizationConfiguration': {
'customCSSUrl': 'string',
'logoUrl': 'string',
'fontUrl': 'string',
'faviconUrl': 'string'
}
}
Response Structure
(dict) --
applicationId (string) --
The identifier of the Amazon Q Business application linked to the web experience.
webExperienceId (string) --
The identifier of the Amazon Q Business web experience.
webExperienceArn (string) --
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
defaultEndpoint (string) --
The endpoint of your Amazon Q Business web experience.
status (string) --
The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
createdAt (datetime) --
The Unix timestamp when the Amazon Q Business web experience was last created.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business web experience was last updated.
title (string) --
The title for your Amazon Q Business web experience.
subtitle (string) --
The subtitle for your Amazon Q Business web experience.
welcomeMessage (string) --
The customized welcome message for end users of an Amazon Q Business web experience.
samplePromptsControlMode (string) --
Determines whether sample prompts are enabled in the web experience for an end user.
origins (list) --
Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p>
(string) --
roleArn (string) --
The Amazon Resource Name (ARN) of the service role attached to your web experience.
identityProviderConfiguration (dict) --
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
samlConfiguration (dict) --
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
authenticationUrl (string) --
The URL where Amazon Q Business end users will be redirected for authentication.
openIDConnectConfiguration (dict) --
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
secretsArn (string) --
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
secretsRole (string) --
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
authenticationConfiguration (dict) --
The authentication configuration information for your Amazon Q Business web experience.
samlConfiguration (dict) --
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
metadataXML (string) --
The metadata XML that your IdP generated.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
userIdAttribute (string) --
The user attribute name in your IdP that maps to the user email.
userGroupAttribute (string) --
The group attribute name in your IdP that maps to user groups.
error (dict) --
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
browserExtensionConfiguration (dict) --
The browser extension configuration for an Amazon Q Business web experience.
enabledBrowserExtensions (list) --
Specify the browser extensions allowed for your Amazon Q web experience.
CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
FIREFOX — Enables the extension for Mozilla Firefox.
CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
(string) --
customizationConfiguration (dict) --
Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
customCSSUrl (string) --
Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
logoUrl (string) --
Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
fontUrl (string) --
Provides the URL where the custom font file is hosted for an Amazon Q web experience.
faviconUrl (string) --
Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
{'applications': {'identityType': {'AWS_QUICKSIGHT_IDP'},
'quickSightConfiguration': {'clientNamespace': 'string'}}}
Lists Amazon Q Business applications.
See also: AWS API Documentation
Request Syntax
client.list_applications(
nextToken='string',
maxResults=123
)
string
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.
integer
The maximum number of Amazon Q Business applications to return.
dict
Response Syntax
{
'nextToken': 'string',
'applications': [
{
'displayName': 'string',
'applicationId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP',
'quickSightConfiguration': {
'clientNamespace': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
applications (list) --
An array of summary information on the configuration of one or more Amazon Q Business applications.
(dict) --
Summary information for an Amazon Q Business application.
displayName (string) --
The name of the Amazon Q Business application.
applicationId (string) --
The identifier for the Amazon Q Business application.
createdAt (datetime) --
The Unix timestamp when the Amazon Q Business application was created.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
status (string) --
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
identityType (string) --
The authentication type being used by a Amazon Q Business application.
quickSightConfiguration (dict) --
The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
clientNamespace (string) --
The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.
{'messages': {'actionReview': {'pluginType': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}}}
Gets a list of messages associated with an Amazon Q Business web experience.
See also: AWS API Documentation
Request Syntax
client.list_messages(
conversationId='string',
applicationId='string',
userId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Q Business web experience conversation.
string
[REQUIRED]
The identifier for the Amazon Q Business application.
string
The identifier of the user involved in the Amazon Q Business web experience conversation.
string
If the number of messages returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
integer
The maximum number of messages to return.
dict
Response Syntax
{
'messages': [
{
'messageId': 'string',
'body': 'string',
'time': datetime(2015, 1, 1),
'type': 'USER'|'SYSTEM',
'attachments': [
{
'name': 'string',
'status': 'FAILED'|'SUCCESS',
'error': {
'errorMessage': 'string',
'errorCode': 'InternalError'|'InvalidRequest'|'ResourceInactive'|'ResourceNotFound'
},
'attachmentId': 'string',
'conversationId': 'string'
},
],
'sourceAttribution': [
{
'title': 'string',
'snippet': 'string',
'url': 'string',
'citationNumber': 123,
'updatedAt': datetime(2015, 1, 1),
'textMessageSegments': [
{
'beginOffset': 123,
'endOffset': 123,
'snippetExcerpt': {
'text': 'string'
},
'mediaId': 'string',
'mediaMimeType': 'string'
},
]
},
],
'actionReview': {
'pluginId': 'string',
'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'payload': {
'string': {
'displayName': 'string',
'displayOrder': 123,
'displayDescription': 'string',
'type': 'STRING'|'NUMBER'|'ARRAY'|'BOOLEAN',
'value': {...}|[...]|123|123.4|'string'|True|None,
'allowedValues': [
{
'value': {...}|[...]|123|123.4|'string'|True|None,
'displayValue': {...}|[...]|123|123.4|'string'|True|None
},
],
'allowedFormat': 'string',
'arrayItemJsonSchema': {...}|[...]|123|123.4|'string'|True|None,
'required': True|False
}
},
'payloadFieldNameSeparator': 'string'
},
'actionExecution': {
'pluginId': 'string',
'payload': {
'string': {
'value': {...}|[...]|123|123.4|'string'|True|None
}
},
'payloadFieldNameSeparator': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
messages (list) --
An array of information on one or more messages.
(dict) --
A message in an Amazon Q Business web experience.
messageId (string) --
The identifier of the Amazon Q Business web experience message.
body (string) --
The content of the Amazon Q Business web experience message.
time (datetime) --
The timestamp of the first Amazon Q Business web experience message.
type (string) --
The type of Amazon Q Business message, whether HUMAN or AI generated.
attachments (list) --
A file directly uploaded into an Amazon Q Business web experience chat.
(dict) --
The details of a file uploaded during chat.
name (string) --
The name of a file uploaded during chat.
status (string) --
The status of a file uploaded during chat.
error (dict) --
An error associated with a file uploaded during chat.
errorMessage (string) --
The message explaining the Amazon Q Business request error.
errorCode (string) --
The code associated with the Amazon Q Business request error.
attachmentId (string) --
The unique identifier of the Amazon Q Business attachment.
conversationId (string) --
The unique identifier of the Amazon Q Business conversation.
sourceAttribution (list) --
The source documents used to generate Amazon Q Business web experience message.
(dict) --
The documents used to generate an Amazon Q Business web experience response.
title (string) --
The title of the document which is the source for the Amazon Q Business generated response.
snippet (string) --
The content extract from the document on which the generated response is based.
url (string) --
The URL of the document which is the source for the Amazon Q Business generated response.
citationNumber (integer) --
The number attached to a citation in an Amazon Q Business generated response.
updatedAt (datetime) --
The Unix timestamp when the Amazon Q Business application was last updated.
textMessageSegments (list) --
A text extract from a source document that is used for source attribution.
(dict) --
Provides information about a text extract in a chat response that can be attributed to a source document.
beginOffset (integer) --
The zero-based location in the response string where the source attribution starts.
endOffset (integer) --
The zero-based location in the response string where the source attribution ends.
snippetExcerpt (dict) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
text (string) --
The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
mediaId (string) --
The identifier of the media object associated with the text segment in the source attribution.
mediaMimeType (string) --
The MIME type (image/png) of the media object associated with the text segment in the source attribution.
actionReview (dict) --
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
pluginId (string) --
The identifier of the plugin associated with the action review.
pluginType (string) --
The type of plugin.
payload (dict) --
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(string) --
(dict) --
A user input field in an plugin action review payload.
displayName (string) --
The name of the field.
displayOrder (integer) --
The display order of fields in a payload.
displayDescription (string) --
The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
type (string) --
The type of field.
value (:ref:`document<document>`) --
The field value.
allowedValues (list) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
(dict) --
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
value (:ref:`document<document>`) --
The field value.
displayValue (:ref:`document<document>`) --
The name of the field.
allowedFormat (string) --
The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.
arrayItemJsonSchema (:ref:`document<document>`) --
Use to create a custom form with array fields (fields with nested objects inside an array).
required (boolean) --
Information about whether the field is required.
payloadFieldNameSeparator (string) --
A string used to retain information about the hierarchical contexts within an action review payload.
actionExecution (dict) --
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
pluginId (string) --
The identifier of the plugin the action is attached to.
payload (dict) --
A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
(string) --
(dict) --
A user input field in an plugin action execution payload.
value (:ref:`document<document>`) --
The content of a user input field in an plugin action execution payload.
payloadFieldNameSeparator (string) --
A string used to retain information about the hierarchical contexts within an action execution event payload.
nextToken (string) --
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
{'plugins': {'type': {'ASANA',
'ATLASSIAN_CONFLUENCE',
'GOOGLE_CALENDAR',
'JIRA_CLOUD',
'MICROSOFT_EXCHANGE',
'MICROSOFT_TEAMS',
'PAGERDUTY_ADVANCE',
'QUICKSIGHT',
'SALESFORCE_CRM',
'SERVICENOW_NOW_PLATFORM',
'SMARTSHEET',
'ZENDESK_SUITE'}}}
Lists configured Amazon Q Business plugins.
See also: AWS API Documentation
Request Syntax
client.list_plugins(
applicationId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the application the plugin is attached to.
string
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
integer
The maximum number of documents to return.
dict
Response Syntax
{
'nextToken': 'string',
'plugins': [
{
'pluginId': 'string',
'displayName': 'string',
'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
'serverUrl': 'string',
'state': 'ENABLED'|'DISABLED',
'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
plugins (list) --
Information about a configured plugin.
(dict) --
Information about an Amazon Q Business plugin and its configuration.
pluginId (string) --
The identifier of the plugin.
displayName (string) --
The name of the plugin.
type (string) --
The type of the plugin.
serverUrl (string) --
The plugin server URL used for configuration.
state (string) --
The current status of the plugin.
buildStatus (string) --
The status of the plugin.
createdAt (datetime) --
The timestamp for when the plugin was created.
updatedAt (datetime) --
The timestamp for when the plugin was last updated.
{'authConfiguration': {'idcAuthConfiguration': {'idcApplicationArn': 'string',
'roleArn': 'string'},
'oAuth2ClientCredentialConfiguration': {'authorizationUrl': 'string',
'tokenUrl': 'string'}}}
Updates an Amazon Q Business plugin.
See also: AWS API Documentation
Request Syntax
client.update_plugin(
applicationId='string',
pluginId='string',
displayName='string',
state='ENABLED'|'DISABLED',
serverUrl='string',
customPluginConfiguration={
'description': 'string',
'apiSchemaType': 'OPEN_API_V3',
'apiSchema': {
'payload': 'string',
's3': {
'bucket': 'string',
'key': 'string'
}
}
},
authConfiguration={
'basicAuthConfiguration': {
'secretArn': 'string',
'roleArn': 'string'
},
'oAuth2ClientCredentialConfiguration': {
'secretArn': 'string',
'roleArn': 'string',
'authorizationUrl': 'string',
'tokenUrl': 'string'
},
'noAuthConfiguration': {}
,
'idcAuthConfiguration': {
'idcApplicationArn': 'string',
'roleArn': 'string'
}
}
)
string
[REQUIRED]
The identifier of the application the plugin is attached to.
string
[REQUIRED]
The identifier of the plugin.
string
The name of the plugin.
string
The status of the plugin.
string
The source URL used for plugin configuration.
dict
The configuration for a custom plugin.
description (string) -- [REQUIRED]
A description for your custom plugin configuration.
apiSchemaType (string) -- [REQUIRED]
The type of OpenAPI schema to use.
apiSchema (dict) -- [REQUIRED]
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
payload (string) --
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
s3 (dict) --
Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
bucket (string) -- [REQUIRED]
The name of the S3 bucket that contains the file.
key (string) -- [REQUIRED]
The name of the file.
dict
The authentication configuration the plugin is using.
basicAuthConfiguration (dict) --
Information about the basic authentication credentials used to configure a plugin.
secretArn (string) -- [REQUIRED]
The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn (string) -- [REQUIRED]
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
oAuth2ClientCredentialConfiguration (dict) --
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn (string) -- [REQUIRED]
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn (string) -- [REQUIRED]
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
authorizationUrl (string) --
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
tokenUrl (string) --
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
noAuthConfiguration (dict) --
Information about invoking a custom plugin without any authentication.
idcAuthConfiguration (dict) --
Information about the IAM Identity Center Application used to configure authentication for a plugin.
idcApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
dict
Response Syntax
{}
Response Structure
(dict) --
{'customizationConfiguration': {'customCSSUrl': 'string',
'faviconUrl': 'string',
'fontUrl': 'string',
'logoUrl': 'string'}}
Updates an Amazon Q Business web experience.
See also: AWS API Documentation
Request Syntax
client.update_web_experience(
applicationId='string',
webExperienceId='string',
roleArn='string',
authenticationConfiguration={
'samlConfiguration': {
'metadataXML': 'string',
'roleArn': 'string',
'userIdAttribute': 'string',
'userGroupAttribute': 'string'
}
},
title='string',
subtitle='string',
welcomeMessage='string',
samplePromptsControlMode='ENABLED'|'DISABLED',
identityProviderConfiguration={
'samlConfiguration': {
'authenticationUrl': 'string'
},
'openIDConnectConfiguration': {
'secretsArn': 'string',
'secretsRole': 'string'
}
},
origins=[
'string',
],
browserExtensionConfiguration={
'enabledBrowserExtensions': [
'FIREFOX'|'CHROME',
]
},
customizationConfiguration={
'customCSSUrl': 'string',
'logoUrl': 'string',
'fontUrl': 'string',
'faviconUrl': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Q Business application attached to the web experience.
string
[REQUIRED]
The identifier of the Amazon Q Business web experience.
string
The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
dict
The authentication configuration of the Amazon Q Business web experience.
samlConfiguration (dict) --
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
metadataXML (string) -- [REQUIRED]
The metadata XML that your IdP generated.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
userIdAttribute (string) -- [REQUIRED]
The user attribute name in your IdP that maps to the user email.
userGroupAttribute (string) --
The group attribute name in your IdP that maps to user groups.
string
The title of the Amazon Q Business web experience.
string
The subtitle of the Amazon Q Business web experience.
string
A customized welcome message for an end user in an Amazon Q Business web experience.
string
Determines whether sample prompts are enabled in the web experience for an end user.
dict
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
samlConfiguration (dict) --
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
authenticationUrl (string) -- [REQUIRED]
The URL where Amazon Q Business end users will be redirected for authentication.
openIDConnectConfiguration (dict) --
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
secretsArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
secretsRole (string) -- [REQUIRED]
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
list
Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
(string) --
dict
The browser extension configuration for an Amazon Q Business web experience.
enabledBrowserExtensions (list) -- [REQUIRED]
Specify the browser extensions allowed for your Amazon Q web experience.
CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
FIREFOX — Enables the extension for Mozilla Firefox.
CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
(string) --
dict
Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.
customCSSUrl (string) --
Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
logoUrl (string) --
Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
fontUrl (string) --
Provides the URL where the custom font file is hosted for an Amazon Q web experience.
faviconUrl (string) --
Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
dict
Response Syntax
{}
Response Structure
(dict) --