Class: AWS.QBusiness
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.QBusiness
- Identifier:
- qbusiness
- API Version:
- 2023-11-27
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
Sending a Request Using QBusiness
var qbusiness = new AWS.QBusiness();
qbusiness.batchDeleteDocument(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the QBusiness object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var qbusiness = new AWS.QBusiness({apiVersion: '2023-11-27'});
You can also set the API version globally in AWS.config.apiVersions
using
the qbusiness service identifier:
AWS.config.apiVersions = {
qbusiness: '2023-11-27',
// other service API versions
};
var qbusiness = new AWS.QBusiness();
Version:
-
2023-11-27
Constructor Summary collapse
-
new AWS.QBusiness(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
batchDeleteDocument(params = {}, callback) ⇒ AWS.Request
Asynchronously deletes one or more documents added using the
BatchPutDocument
API from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
. -
batchPutDocument(params = {}, callback) ⇒ AWS.Request
Adds one or more documents to an Amazon Q Business index.
You use this API to:
-
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
-
add custom attributes to documents in an Amazon Q Business index.
-
attach an access control list to the documents added to an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
. -
-
chatSync(params = {}, callback) ⇒ AWS.Request
Starts or continues a non-streaming Amazon Q Business conversation.
.
-
createApplication(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business application.
Note: There are new tiers for Amazon Q Business.- createDataSource(params = {}, callback) ⇒ AWS.Request
Creates a data source connector for an Amazon Q Business application.
CreateDataSource
is a synchronous operation.- createIndex(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business index.
To determine if index creation has completed, check the
Status
field returned from a call toDescribeIndex
.- createPlugin(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business plugin.
.
- createRetriever(params = {}, callback) ⇒ AWS.Request
Adds a retriever to your Amazon Q Business application.
.
- createUser(params = {}, callback) ⇒ AWS.Request
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
.
- createWebExperience(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business web experience.
.
- deleteApplication(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business application.
.
- deleteChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes chat controls configured for an existing Amazon Q Business application.
.
- deleteConversation(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business web experience conversation.
.
- deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business data source connector.
- deleteGroup(params = {}, callback) ⇒ AWS.Request
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
- deleteIndex(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business index.
.
- deletePlugin(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business plugin.
.
- deleteRetriever(params = {}, callback) ⇒ AWS.Request
Deletes the retriever used by an Amazon Q Business application.
.
- deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes a user by email id.
.
- deleteWebExperience(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business web experience.
.
- getApplication(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business application.
.
- getChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about an chat controls configured for an existing Amazon Q Business application.
.
- getDataSource(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business data source connector.
.
- getGroup(params = {}, callback) ⇒ AWS.Request
Describes a group by group name.
.
- getIndex(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business index.
.
- getPlugin(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business plugin.
.
- getRetriever(params = {}, callback) ⇒ AWS.Request
Gets information about an existing retriever used by an Amazon Q Business application.
.
- getUser(params = {}, callback) ⇒ AWS.Request
Describes the universally unique identifier (UUID) associated with a local user in a data source.
.
- getWebExperience(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business web experience.
.
- listApplications(params = {}, callback) ⇒ AWS.Request
Lists Amazon Q Business applications.
.
- listConversations(params = {}, callback) ⇒ AWS.Request
Lists one or more Amazon Q Business conversations.
.
- listDataSources(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Q Business data source connectors that you have created.
.
- listDataSourceSyncJobs(params = {}, callback) ⇒ AWS.Request
Get information about an Amazon Q Business data source connector synchronization.
.
- listDocuments(params = {}, callback) ⇒ AWS.Request
A list of documents attached to an index.
.
- listGroups(params = {}, callback) ⇒ AWS.Request
Provides a list of groups that are mapped to users.
.
- listIndices(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Q Business indices you have created.
.
- listMessages(params = {}, callback) ⇒ AWS.Request
Gets a list of messages associated with an Amazon Q Business web experience.
.
- listPlugins(params = {}, callback) ⇒ AWS.Request
Lists configured Amazon Q Business plugins.
.
- listRetrievers(params = {}, callback) ⇒ AWS.Request
Lists the retriever used by an Amazon Q Business application.
.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
Gets a list of tags associated with a specified resource.
- listWebExperiences(params = {}, callback) ⇒ AWS.Request
Lists one or more Amazon Q Business Web Experiences.
.
- putFeedback(params = {}, callback) ⇒ AWS.Request
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
.
- putGroup(params = {}, callback) ⇒ AWS.Request
Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups.
- startDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request
Starts a data source connector synchronization job.
- stopDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request
Stops an Amazon Q Business data source connector synchronization job already in progress.
.
- tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tag to the specified Amazon Q Business application or data source resource.
- untagResource(params = {}, callback) ⇒ AWS.Request
Removes a tag from an Amazon Q Business application or a data source.
.
- updateApplication(params = {}, callback) ⇒ AWS.Request
Updates an existing Amazon Q Business application.
.
- updateChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Updates an set of chat controls configured for an existing Amazon Q Business application.
.
- updateDataSource(params = {}, callback) ⇒ AWS.Request
Updates an existing Amazon Q Business data source connector.
.
- updateIndex(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business index.
.
- updatePlugin(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business plugin.
.
- updateRetriever(params = {}, callback) ⇒ AWS.Request
Updates the retriever used for your Amazon Q Business application.
.
- updateUser(params = {}, callback) ⇒ AWS.Request
Updates a information associated with a user id.
.
- updateWebExperience(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business web experience.
- waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given QBusiness resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
new AWS.QBusiness(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a QBusiness object
var qbusiness = new AWS.QBusiness({apiVersion: '2023-11-27'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.QBusiness.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.QBusiness.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.QBusiness.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
batchDeleteDocument(params = {}, callback) ⇒ AWS.Request
Asynchronously deletes one or more documents added using the
BatchPutDocument
API from an Amazon Q Business index.You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Service Reference:
Examples:
Calling the batchDeleteDocument operation
var params = { applicationId: 'STRING_VALUE', /* required */ documents: [ /* required */ { documentId: 'STRING_VALUE' /* required */ }, /* more items */ ], indexId: 'STRING_VALUE', /* required */ dataSourceSyncId: 'STRING_VALUE' }; qbusiness.batchDeleteDocument(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
indexId
— (String
)The identifier of the Amazon Q Business index that contains the documents to delete.
documents
— (Array<map>
)Documents deleted from the Amazon Q Business index.
documentId
— required — (String
)The identifier of the deleted document.
dataSourceSyncId
— (String
)The identifier of the data source sync during which the documents were deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:failedDocuments
— (Array<map>
)A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
id
— (String
)The identifier of the document that couldn't be removed from the Amazon Q Business index.
error
— (map
)An explanation for why the document couldn't be removed from the index.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
dataSourceId
— (String
)The identifier of the Amazon Q Business data source connector that contains the failed document.
-
(AWS.Response)
—
Returns:
batchPutDocument(params = {}, callback) ⇒ AWS.Request
Adds one or more documents to an Amazon Q Business index.
You use this API to:
-
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
-
add custom attributes to documents in an Amazon Q Business index.
-
attach an access control list to the documents added to an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Service Reference:
Examples:
Calling the batchPutDocument operation
var params = { applicationId: 'STRING_VALUE', /* required */ documents: [ /* required */ { id: 'STRING_VALUE', /* required */ accessConfiguration: { accessControls: [ /* required */ { principals: [ /* required */ { group: { access: ALLOW | DENY, /* required */ membershipType: INDEX | DATASOURCE, name: 'STRING_VALUE' }, user: { access: ALLOW | DENY, /* required */ id: 'STRING_VALUE', membershipType: INDEX | DATASOURCE } }, /* more items */ ], memberRelation: AND | OR }, /* more items */ ], memberRelation: AND | OR }, attributes: [ { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, /* more items */ ], content: { blob: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, s3: { bucket: 'STRING_VALUE', /* required */ key: 'STRING_VALUE' /* required */ } }, contentType: PDF | HTML | MS_WORD | PLAIN_TEXT | PPT | RTF | XML | XSLT | MS_EXCEL | CSV | JSON | MD, documentEnrichmentConfiguration: { inlineConfigurations: [ { condition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, documentContentOperator: DELETE, target: { key: 'STRING_VALUE', /* required */ attributeValueOperator: DELETE, value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } } }, /* more items */ ], postExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' }, preExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' } }, title: 'STRING_VALUE' }, /* more items */ ], indexId: 'STRING_VALUE', /* required */ dataSourceSyncId: 'STRING_VALUE', roleArn: 'STRING_VALUE' }; qbusiness.batchPutDocument(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
indexId
— (String
)The identifier of the Amazon Q Business index to add the documents to.
documents
— (Array<map>
)One or more documents to add to the index.
id
— required — (String
)The identifier of the document.
attributes
— (Array<map>
)Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
content
— (map
)The contents of the document.
blob
— (Buffer, Typed Array, Blob, String
)The contents of the document. Documents passed to the
blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.s3
— (map
)The path to the document in an Amazon S3 bucket.
bucket
— required — (String
)The name of the S3 bucket that contains the file.
key
— required — (String
)The name of the file.
contentType
— (String
)The file type of the document in the Blob field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the
Possible values include:HTML
start and closing tags (<HTML>content</HTML>
) around the content."PDF"
"HTML"
"MS_WORD"
"PLAIN_TEXT"
"PPT"
"RTF"
"XML"
"XSLT"
"MS_EXCEL"
"CSV"
"JSON"
"MD"
title
— (String
)The title of the document.
accessConfiguration
— (map
)Configuration information for access permission to a document.
accessControls
— required — (Array<map>
)A list of
AccessControlList
objects.principals
— required — (Array<map>
)Contains a list of principals, where a principal can be either a
USER
or aGROUP
. Each principal can be have the following type of document access:ALLOW
orDENY
.user
— (map
)The user associated with the principal.
id
— (String
)The identifier of the user.
access
— required — (String
)Provides information about whether to allow or deny access to the principal.
Possible values include:"ALLOW"
"DENY"
membershipType
— (String
)The type of group.
Possible values include:"INDEX"
"DATASOURCE"
group
— (map
)The group associated with the principal.
name
— (String
)The name of the group.
access
— required — (String
)Provides information about whether to allow or deny access to the principal.
Possible values include:"ALLOW"
"DENY"
membershipType
— (String
)The type of group.
Possible values include:"INDEX"
"DATASOURCE"
memberRelation
— (String
)Describes the member relation within a principal list.
Possible values include:"AND"
"OR"
memberRelation
— (String
)Describes the member relation within the
Possible values include:AccessControlList
object."AND"
"OR"
documentEnrichmentConfiguration
— (map
)The configuration information for altering document metadata and content during the document ingestion process.
inlineConfigurations
— (Array<map>
)Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
condition
— (map
)The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with
DocumentAttributeTarget
to apply the condition.For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
target
— (map
)The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to
TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.You can also use this with
DocumentAttributeCondition
.key
— required — (String
)The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
attributeValueOperator
— (String
)TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
."DELETE"
documentContentOperator
— (String
)TRUE
to delete content if the condition used for the target attribute is met."DELETE"
preExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
postExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
dataSourceSyncId
— (String
)The identifier of the data source sync during which the documents were added.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:failedDocuments
— (Array<map>
)A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
id
— (String
)The identifier of the document that couldn't be removed from the Amazon Q Business index.
error
— (map
)An explanation for why the document couldn't be removed from the index.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
dataSourceId
— (String
)The identifier of the Amazon Q Business data source connector that contains the failed document.
-
(AWS.Response)
—
Returns:
chatSync(params = {}, callback) ⇒ AWS.Request
Starts or continues a non-streaming Amazon Q Business conversation.
Service Reference:
Examples:
Calling the chatSync operation
var params = { applicationId: 'STRING_VALUE', /* required */ actionExecution: { payload: { /* required */ '<ActionPayloadFieldKey>': { value: { /* required */ } }, /* '<ActionPayloadFieldKey>': ... */ }, payloadFieldNameSeparator: 'STRING_VALUE', /* required */ pluginId: 'STRING_VALUE' /* required */ }, attachments: [ { data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */ name: 'STRING_VALUE' /* required */ }, /* more items */ ], attributeFilter: { /* AttributeFilter */ andAllFilters: [ /* recursive AttributeFilter */, /* more items */ ], containsAll: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, containsAny: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, equalsTo: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, greaterThan: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, greaterThanOrEquals: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lessThan: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lessThanOrEquals: { name: 'STRING_VALUE', /* required */ value: { /* required */ dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, notFilter: /* recursive AttributeFilter */, orAllFilters: [ /* recursive AttributeFilter */, /* more items */ ] }, authChallengeResponse: { responseMap: { /* required */ '<AuthResponseKey>': 'STRING_VALUE', /* '<AuthResponseKey>': ... */ } }, chatMode: RETRIEVAL_MODE | CREATOR_MODE | PLUGIN_MODE, chatModeConfiguration: { pluginConfiguration: { pluginId: 'STRING_VALUE' /* required */ } }, clientToken: 'STRING_VALUE', conversationId: 'STRING_VALUE', parentMessageId: 'STRING_VALUE', userGroups: [ 'STRING_VALUE', /* more items */ ], userId: 'STRING_VALUE', userMessage: 'STRING_VALUE' }; qbusiness.chatSync(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
userId
— (String
)The identifier of the user attached to the chat input.
userGroups
— (Array<String>
)The groups that a user associated with the chat input belongs to.
userMessage
— (String
)A end user message in a conversation.
attachments
— (Array<map>
)A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
name
— required — (String
)The name of the file.
data
— required — (Buffer, Typed Array, Blob, String
)The data contained within the uploaded file.
actionExecution
— (map
)A request from an end user to perform an Amazon Q Business plugin action.
pluginId
— required — (String
)The identifier of the plugin the action is attached to.
payload
— required — (map<map>
)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.
value
— required — (map
)The content of a user input field in an plugin action execution payload.
payloadFieldNameSeparator
— required — (String
)A string used to retain information about the hierarchical contexts within an action execution event payload.
authChallengeResponse
— (map
)An authentication verification event response by a third party authentication server to Amazon Q Business.
responseMap
— required — (map<String>
)The mapping of key-value pairs in an authentication challenge response.
conversationId
— (String
)The identifier of the Amazon Q Business conversation.
parentMessageId
— (String
)The identifier of the previous system message in a conversation.
attributeFilter
— (map
)Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
andAllFilters
— (Array<map>
)Performs a logical
AND
operation on all supplied filters.equalsTo
— (map
)Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
,longValue
,stringListValue
andstringValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Returns
true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)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
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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.
orAllFilters
— (Array<map>
)Performs a logical
OR
operation on all supplied filters.equalsTo
— (map
)Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
,longValue
,stringListValue
andstringValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Returns
true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)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
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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.
notFilter
— (map
)Performs a logical
NOT
operation on all supplied filters.andAllFilters
— (Array<map>
)Performs a logical
AND
operation on all supplied filters.orAllFilters
— (Array<map>
)Performs a logical
OR
operation on all supplied filters.equalsTo
— (map
)Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
,longValue
,stringListValue
andstringValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Returns
true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)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
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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.
equalsTo
— (map
)Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
,longValue
,stringListValue
andstringValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Returns
true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)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
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)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
— (map
)Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValue
andlongValue
.name
— required — (String
)The identifier for the attribute.
value
— required — (map
)The value of the attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
chatMode
— (String
)The chat modes available to an Amazon Q Business end user.
-
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application. -
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request. -
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
Possible values include:"RETRIEVAL_MODE"
"CREATOR_MODE"
"PLUGIN_MODE"
-
chatModeConfiguration
— (map
)The chat mode configuration for an Amazon Q Business application.
pluginConfiguration
— (map
)Configuration information required to invoke chat in
PLUGIN_MODE
.pluginId
— required — (String
)The identifier of the plugin you want to use.
clientToken
— (String
)A token that you provide to identify a chat request.
If a token is not provided, the SDK will use a version 4 UUID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (map
)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.
Possible values include:"SERVICE_NOW"
"SALESFORCE"
"JIRA"
"ZENDESK"
"CUSTOM"
payload
— (map<map>
)Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
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.
Possible values include:"STRING"
"NUMBER"
"ARRAY"
"BOOLEAN"
value
— (map
)The field value.
allowedValues
— (Array<map>
)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
— (map
)The field value.
displayValue
— (map
)The name of the field.
allowedFormat
— (String
)The expected data format for the action review input field value. For example, in PTO request,
from
andto
would be ofdatetime
allowed format.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
— (map
)An authentication verification event activated by an end user request to use a custom plugin.
authorizationUrl
— required — (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
— (Array<map>
)The source documents used to generate the conversation 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
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
textMessageSegments
— (Array<map>
)A text extract from a source document that is used for source attribution.
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
— (map
)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.
failedAttachments
— (Array<map>
)A list of files which failed to upload during chat.
name
— (String
)The name of a file uploaded during chat.
status
— (String
)The status of a file uploaded during chat.
Possible values include:"FAILED"
"SUCCEEDED"
error
— (map
)An error associated with a file uploaded during chat.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
-
(AWS.Response)
—
Returns:
createApplication(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business application.
Note: There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.Service Reference:
Examples:
Calling the createApplication operation
var params = { displayName: 'STRING_VALUE', /* required */ attachmentsConfiguration: { attachmentsControlMode: ENABLED | DISABLED /* required */ }, clientToken: 'STRING_VALUE', description: 'STRING_VALUE', encryptionConfiguration: { kmsKeyId: 'STRING_VALUE' }, identityCenterInstanceArn: 'STRING_VALUE', personalizationConfiguration: { personalizationControlMode: ENABLED | DISABLED /* required */ }, qAppsConfiguration: { qAppsControlMode: ENABLED | DISABLED /* required */ }, roleArn: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; qbusiness.createApplication(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
displayName
— (String
)A name for the Amazon Q Business application.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
identityCenterInstanceArn
— (String
)The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
description
— (String
)A description for the Amazon Q Business application.
encryptionConfiguration
— (map
)The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
kmsKeyId
— (String
)The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
tags
— (Array<map>
)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: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
clientToken
— (String
)A token that you provide to identify the request to create your Amazon Q Business application.
If a token is not provided, the SDK will use a version 4 UUID.attachmentsConfiguration
— (map
)An option to allow end users to upload files directly during chat.
attachmentsControlMode
— required — (String
)Status information about whether file upload functionality is activated or deactivated for your end user.
Possible values include:"ENABLED"
"DISABLED"
qAppsConfiguration
— (map
)An option to allow end users to create and use Amazon Q Apps in the web experience.
qAppsControlMode
— required — (String
)Status information about whether end users can create and use Amazon Q Apps in the web experience.
Possible values include:"ENABLED"
"DISABLED"
personalizationConfiguration
— (map
)Configuration information about chat response personalization. For more information, see Personalizing chat responses
personalizationControlMode
— required — (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.
Possible values include:"ENABLED"
"DISABLED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:applicationId
— (String
)The identifier of the Amazon Q Business application.
applicationArn
— (String
)The Amazon Resource Name (ARN) of the Amazon Q Business application.
-
(AWS.Response)
—
Returns:
createDataSource(params = {}, callback) ⇒ AWS.Request
Creates a data source connector for an Amazon Q Business application.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.Service Reference:
Examples:
Calling the createDataSource operation
var params = { applicationId: 'STRING_VALUE', /* required */ configuration: { /* required */ }, displayName: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', description: 'STRING_VALUE', documentEnrichmentConfiguration: { inlineConfigurations: [ { condition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, documentContentOperator: DELETE, target: { key: 'STRING_VALUE', /* required */ attributeValueOperator: DELETE, value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } } }, /* more items */ ], postExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' }, preExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' } }, roleArn: 'STRING_VALUE', syncSchedule: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], vpcConfiguration: { securityGroupIds: [ /* required */ 'STRING_VALUE', /* more items */ ], subnetIds: [ /* required */ 'STRING_VALUE', /* more items */ ] } }; qbusiness.createDataSource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application the data source will be attached to.
indexId
— (String
)The identifier of the index that you want to use with the data source connector.
displayName
— (String
)A name for the data source connector.
configuration
— (map
)Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
vpcConfiguration
— (map
)Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
subnetIds
— required — (Array<String>
)A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
securityGroupIds
— required — (Array<String>
)A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
description
— (String
)A description for the data source connector.
tags
— (Array<map>
)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: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
syncSchedule
— (String
)Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a
cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify theSchedule
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
clientToken
— (String
)A token you provide to identify a request to create a data source connector. Multiple calls to the
If a token is not provided, the SDK will use a version 4 UUID.CreateDataSource
API with the same client token will create only one data source connector.documentEnrichmentConfiguration
— (map
)Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
inlineConfigurations
— (Array<map>
)Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
condition
— (map
)The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with
DocumentAttributeTarget
to apply the condition.For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
target
— (map
)The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to
TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.You can also use this with
DocumentAttributeCondition
.key
— required — (String
)The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
attributeValueOperator
— (String
)TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
."DELETE"
documentContentOperator
— (String
)TRUE
to delete content if the condition used for the target attribute is met."DELETE"
preExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
postExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dataSourceId
— (String
)The identifier of the data source connector.
dataSourceArn
— (String
)The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
-
(AWS.Response)
—
Returns:
createIndex(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business index.
To determine if index creation has completed, check the
Status
field returned from a call toDescribeIndex
. TheStatus
field is set toACTIVE
when the index is ready to use.Once the index is active, you can index your documents using the
BatchPutDocument
API or theCreateDataSource
API.Service Reference:
Examples:
Calling the createIndex operation
var params = { applicationId: 'STRING_VALUE', /* required */ displayName: 'STRING_VALUE', /* required */ capacityConfiguration: { units: 'NUMBER_VALUE' }, clientToken: 'STRING_VALUE', description: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], type: ENTERPRISE | STARTER }; qbusiness.createIndex(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application using the index.
displayName
— (String
)A name for the Amazon Q Business index.
type
— (String
)The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.
Possible values include:"ENTERPRISE"
"STARTER"
description
— (String
)A description for the Amazon Q Business index.
tags
— (Array<map>
)A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
capacityConfiguration
— (map
)The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
units
— (Integer
)The number of storage units configured for an Amazon Q Business index.
clientToken
— (String
)A token that you provide to identify the request to create an index. Multiple calls to the
If a token is not provided, the SDK will use a version 4 UUID.CreateIndex
API with the same client token will create only one index.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:indexId
— (String
)The identifier for the Amazon Q Business index.
indexArn
— (String
)The Amazon Resource Name (ARN) of an Amazon Q Business index.
-
(AWS.Response)
—
Returns:
createPlugin(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business plugin.
Service Reference:
Examples:
Calling the createPlugin operation
var params = { applicationId: 'STRING_VALUE', /* required */ authConfiguration: { /* required */ basicAuthConfiguration: { roleArn: 'STRING_VALUE', /* required */ secretArn: 'STRING_VALUE' /* required */ }, noAuthConfiguration: { }, oAuth2ClientCredentialConfiguration: { roleArn: 'STRING_VALUE', /* required */ secretArn: 'STRING_VALUE' /* required */ } }, displayName: 'STRING_VALUE', /* required */ type: SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM, /* required */ clientToken: 'STRING_VALUE', customPluginConfiguration: { apiSchema: { /* required */ payload: 'STRING_VALUE', s3: { bucket: 'STRING_VALUE', /* required */ key: 'STRING_VALUE' /* required */ } }, apiSchemaType: OPEN_API_V3, /* required */ description: 'STRING_VALUE' /* required */ }, serverUrl: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; qbusiness.createPlugin(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application that will contain the plugin.
displayName
— (String
)A the name for your plugin.
type
— (String
)The type of plugin you want to create.
Possible values include:"SERVICE_NOW"
"SALESFORCE"
"JIRA"
"ZENDESK"
"CUSTOM"
authConfiguration
— (map
)Authentication configuration information for an Amazon Q Business plugin.
basicAuthConfiguration
— (map
)Information about the basic authentication credentials used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn
— required — (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
— (map
)Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn
— required — (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.
noAuthConfiguration
— (map
)Information about invoking a custom plugin without any authentication.
serverUrl
— (String
)The source URL used for plugin configuration.
customPluginConfiguration
— (map
)Contains configuration for a custom plugin.
description
— required — (String
)A description for your custom plugin configuration.
apiSchemaType
— required — (String
)The type of OpenAPI schema to use.
Possible values include:"OPEN_API_V3"
apiSchema
— required — (map
)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
— (map
)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
— required — (String
)The name of the S3 bucket that contains the file.
key
— required — (String
)The name of the file.
tags
— (Array<map>
)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: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
clientToken
— (String
)A token that you provide to identify the request to create your Amazon Q Business plugin.
If a token is not provided, the SDK will use a version 4 UUID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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.
Possible values include:"READY"
"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
-
(AWS.Response)
—
Returns:
createRetriever(params = {}, callback) ⇒ AWS.Request
Adds a retriever to your Amazon Q Business application.
Service Reference:
Examples:
Calling the createRetriever operation
var params = { applicationId: 'STRING_VALUE', /* required */ configuration: { /* required */ kendraIndexConfiguration: { indexId: 'STRING_VALUE' /* required */ }, nativeIndexConfiguration: { indexId: 'STRING_VALUE', /* required */ boostingOverride: { '<DocumentAttributeKey>': { dateConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ boostingDurationInSeconds: 'NUMBER_VALUE' }, numberConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ boostingType: PRIORITIZE_LARGER_VALUES | PRIORITIZE_SMALLER_VALUES }, stringConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ attributeValueBoosting: { '<String>': LOW | MEDIUM | HIGH | VERY_HIGH, /* '<String>': ... */ } }, stringListConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH /* required */ } }, /* '<DocumentAttributeKey>': ... */ } } }, displayName: 'STRING_VALUE', /* required */ type: NATIVE_INDEX | KENDRA_INDEX, /* required */ clientToken: 'STRING_VALUE', roleArn: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; qbusiness.createRetriever(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of your Amazon Q Business application.
type
— (String
)The type of retriever you are using.
Possible values include:"NATIVE_INDEX"
"KENDRA_INDEX"
displayName
— (String
)The name of your retriever.
configuration
— (map
)Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration
— (map
)Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier for the Amazon Q Business index.
boostingOverride
— (map<map>
)Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
numberConfiguration
— (map
)Provides information on boosting
NUMBER
type document attributes.boostingLevel
— required — (String
)Specifies the duration, in seconds, of a boost applies to a
Possible values include:NUMBER
type document attribute."NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingType
— (String
)Specifies how much a document attribute is boosted.
Possible values include:"PRIORITIZE_LARGER_VALUES"
"PRIORITIZE_SMALLER_VALUES"
stringConfiguration
— (map
)Provides information on boosting
STRING
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
attributeValueBoosting
— (map<String>
)Specifies specific values of a
STRING
type document attribute being boosted.
dateConfiguration
— (map
)Provides information on boosting
DATE
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingDurationInSeconds
— (Integer
)Specifies the duration, in seconds, of a boost applies to a
DATE
type document attribute.
stringListConfiguration
— (map
)Provides information on boosting
STRING_LIST
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
kendraIndexConfiguration
— (map
)Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier of the Amazon Kendra index.
roleArn
— (String
)The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
clientToken
— (String
)A token that you provide to identify the request to create your Amazon Q Business application retriever.
If a token is not provided, the SDK will use a version 4 UUID.tags
— (Array<map>
)A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:retrieverId
— (String
)The identifier of the retriever you are using.
retrieverArn
— (String
)The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
-
(AWS.Response)
—
Returns:
createUser(params = {}, callback) ⇒ AWS.Request
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
Service Reference:
Examples:
Calling the createUser operation
var params = { applicationId: 'STRING_VALUE', /* required */ userId: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', userAliases: [ { userId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', indexId: 'STRING_VALUE' }, /* more items */ ] }; qbusiness.createUser(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application for which the user mapping will be created.
userId
— (String
)The user emails attached to a user mapping.
userAliases
— (Array<map>
)The list of user aliases in the mapping.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
clientToken
— (String
)A token that you provide to identify the request to create your Amazon Q Business user mapping.
If a token is not provided, the SDK will use a version 4 UUID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
createWebExperience(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Q Business web experience.
Service Reference:
Examples:
Calling the createWebExperience operation
var params = { applicationId: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', roleArn: 'STRING_VALUE', samplePromptsControlMode: ENABLED | DISABLED, subtitle: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ], title: 'STRING_VALUE', welcomeMessage: 'STRING_VALUE' }; qbusiness.createWebExperience(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business web experience.
title
— (String
)The title for your Amazon Q Business web experience.
subtitle
— (String
)A subtitle to personalize your Amazon Q Business web experience.
welcomeMessage
— (String
)The customized welcome message for end users of an Amazon Q Business web experience.
samplePromptsControlMode
— (String
)Determines whether sample prompts are enabled in the web experience for an end user.
Possible values include:"ENABLED"
"DISABLED"
roleArn
— (String
)The Amazon Resource Name (ARN) of the service role attached to your web experience.
tags
— (Array<map>
)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: _ . : / = + - @.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
clientToken
— (String
)A token you provide to identify a request to create an Amazon Q Business web experience.
If a token is not provided, the SDK will use a version 4 UUID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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.
-
(AWS.Response)
—
Returns:
deleteApplication(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business application.
Service Reference:
Examples:
Calling the deleteApplication operation
var params = { applicationId: 'STRING_VALUE' /* required */ }; qbusiness.deleteApplication(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes chat controls configured for an existing Amazon Q Business application.
Service Reference:
Examples:
Calling the deleteChatControlsConfiguration operation
var params = { applicationId: 'STRING_VALUE' /* required */ }; qbusiness.deleteChatControlsConfiguration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application the chat controls have been configured for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteConversation(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business web experience conversation.
Service Reference:
Examples:
Calling the deleteConversation operation
var params = { applicationId: 'STRING_VALUE', /* required */ conversationId: 'STRING_VALUE', /* required */ userId: 'STRING_VALUE' }; qbusiness.deleteConversation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
conversationId
— (String
)The identifier of the Amazon Q Business web experience conversation being deleted.
applicationId
— (String
)The identifier of the Amazon Q Business application associated with the conversation.
userId
— (String
)The identifier of the user who is deleting the conversation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business data source connector. While the data source is being deleted, the
Status
field returned by a call to theDescribeDataSource
API is set toDELETING
.Service Reference:
Examples:
Calling the deleteDataSource operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.deleteDataSource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application used with the data source connector.
indexId
— (String
)The identifier of the index used with the data source connector.
dataSourceId
— (String
)The identifier of the data source connector that you want to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteGroup(params = {}, callback) ⇒ AWS.Request
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.
If you want to delete, update, or replace users or sub groups of a group, you need to use the
PutGroup
operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when callingPutGroup
.Service Reference:
Examples:
Calling the deleteGroup operation
var params = { applicationId: 'STRING_VALUE', /* required */ groupName: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE' }; qbusiness.deleteGroup(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application in which the group mapping belongs.
indexId
— (String
)The identifier of the index you want to delete the group from.
groupName
— (String
)The name of the group you want to delete.
dataSourceId
— (String
)The identifier of the data source linked to the group
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteIndex(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business index.
Service Reference:
Examples:
Calling the deleteIndex operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.deleteIndex(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
indexId
— (String
)The identifier of the Amazon Q Business index.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deletePlugin(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business plugin.
Service Reference:
Examples:
Calling the deletePlugin operation
var params = { applicationId: 'STRING_VALUE', /* required */ pluginId: 'STRING_VALUE' /* required */ }; qbusiness.deletePlugin(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier the application attached to the Amazon Q Business plugin.
pluginId
— (String
)The identifier of the plugin being deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteRetriever(params = {}, callback) ⇒ AWS.Request
Deletes the retriever used by an Amazon Q Business application.
Service Reference:
Examples:
Calling the deleteRetriever operation
var params = { applicationId: 'STRING_VALUE', /* required */ retrieverId: 'STRING_VALUE' /* required */ }; qbusiness.deleteRetriever(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application using the retriever.
retrieverId
— (String
)The identifier of the retriever being deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes a user by email id.
Service Reference:
Examples:
Calling the deleteUser operation
var params = { applicationId: 'STRING_VALUE', /* required */ userId: 'STRING_VALUE' /* required */ }; qbusiness.deleteUser(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application from which the user is being deleted.
userId
— (String
)The user email being deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteWebExperience(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Q Business web experience.
Service Reference:
Examples:
Calling the deleteWebExperience operation
var params = { applicationId: 'STRING_VALUE', /* required */ webExperienceId: 'STRING_VALUE' /* required */ }; qbusiness.deleteWebExperience(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
webExperienceId
— (String
)The identifier of the Amazon Q Business web experience being deleted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
getApplication(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business application.
Service Reference:
Examples:
Calling the getApplication operation
var params = { applicationId: 'STRING_VALUE' /* required */ }; qbusiness.getApplication(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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.
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.
Possible values include:"CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
description
— (String
)A description for the Amazon Q Business application.
encryptionConfiguration
— (map
)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
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
updatedAt
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
error
— (map
)If the
Status
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail.errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
attachmentsConfiguration
— (map
)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.
Possible values include:"ENABLED"
"DISABLED"
qAppsConfiguration
— (map
)Settings for whether end users can create and use Amazon Q Apps in the web experience.
qAppsControlMode
— required — (String
)Status information about whether end users can create and use Amazon Q Apps in the web experience.
Possible values include:"ENABLED"
"DISABLED"
personalizationConfiguration
— (map
)Configuration information about chat response personalization. For more information, see Personalizing chat responses.
personalizationControlMode
— required — (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.
Possible values include:"ENABLED"
"DISABLED"
-
(AWS.Response)
—
Returns:
getChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about an chat controls configured for an existing Amazon Q Business application.
Service Reference:
Examples:
Calling the getChatControlsConfiguration operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.getChatControlsConfiguration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application for which the chat controls are configured.
maxResults
— (Integer
)The maximum number of configured chat controls to return.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:responseScope
— (String
)The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
Possible values include:"ENTERPRISE_CONTENT_ONLY"
"EXTENDED_KNOWLEDGE_ENABLED"
blockedPhrases
— (map
)The phrases blocked from chat by your chat control configuration.
blockedPhrases
— (Array<String>
)A list of phrases blocked from a Amazon Q Business web experience chat.
systemMessageOverride
— (String
)The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
topicConfigurations
— (Array<map>
)The topic specific controls configured for a Amazon Q Business application.
name
— required — (String
)A name for your topic control configuration.
description
— (String
)A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
exampleChatMessages
— (Array<String>
)A list of example phrases that you expect the end user to use in relation to the topic.
rules
— required — (Array<map>
)Rules defined for a topic configuration.
includedUsersAndGroups
— (map
)Users and groups to be included in a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
excludedUsersAndGroups
— (map
)Users and groups to be excluded from a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
ruleType
— required — (String
)The type of rule.
Possible values include:"CONTENT_BLOCKER_RULE"
"CONTENT_RETRIEVAL_RULE"
ruleConfiguration
— (map
)The configuration information for a rule.
contentBlockerRule
— (map
)A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
systemMessageOverride
— (String
)The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
contentRetrievalRule
— (map
)Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
eligibleDataSources
— (Array<map>
)Specifies data sources in a Amazon Q Business application to use for content generation.
indexId
— (String
)The identifier of the index the data source is attached to.
dataSourceId
— (String
)The identifier of the data source.
creatorModeConfiguration
— (map
)The configuration details for
CREATOR_MODE
.creatorModeControl
— required — (String
)Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
Possible values include:"ENABLED"
"DISABLED"
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
-
(AWS.Response)
—
Returns:
getDataSource(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business data source connector.
Service Reference:
Examples:
Calling the getDataSource operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.getDataSource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
indexId
— (String
)The identfier of the index used with the data source connector.
dataSourceId
— (String
)The identifier of the data source connector.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:applicationId
— (String
)The identifier of the Amazon Q Business application.
indexId
— (String
)The identifier of the index linked to the data source connector.
dataSourceId
— (String
)The identifier of the data source connector.
dataSourceArn
— (String
)The Amazon Resource Name (ARN) of the data source.
displayName
— (String
)The name for the data source connector.
type
— (String
)The type of the data source connector. For example,
S3
.configuration
— (map
)The details of how the data source connector is configured.
vpcConfiguration
— (map
)Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
subnetIds
— required — (Array<String>
)A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
securityGroupIds
— required — (Array<String>
)A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
createdAt
— (Date
)The Unix timestamp when the data source connector was created.
updatedAt
— (Date
)The Unix timestamp when the data source connector was last updated.
description
— (String
)The description for the data source connector.
status
— (String
)The current status of the data source connector. When the
Possible values include:Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail."PENDING_CREATION"
"CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
syncSchedule
— (String
)The schedule for Amazon Q Business to update the index.
roleArn
— (String
)The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
error
— (map
)When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
documentEnrichmentConfiguration
— (map
)Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
inlineConfigurations
— (Array<map>
)Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
condition
— (map
)The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with
DocumentAttributeTarget
to apply the condition.For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
target
— (map
)The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to
TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.You can also use this with
DocumentAttributeCondition
.key
— required — (String
)The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
attributeValueOperator
— (String
)TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
."DELETE"
documentContentOperator
— (String
)TRUE
to delete content if the condition used for the target attribute is met."DELETE"
preExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
postExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
-
(AWS.Response)
—
Returns:
getGroup(params = {}, callback) ⇒ AWS.Request
Describes a group by group name.
Service Reference:
Examples:
Calling the getGroup operation
var params = { applicationId: 'STRING_VALUE', /* required */ groupName: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE' }; qbusiness.getGroup(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application id the group is attached to.
indexId
— (String
)The identifier of the index the group is attached to.
groupName
— (String
)The name of the group.
dataSourceId
— (String
)The identifier of the data source the group is attached to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:status
— (map
)The current status of the group.
status
— (String
)The status of a group.
Possible values include:"FAILED"
"SUCCEEDED"
"PROCESSING"
"DELETING"
"DELETED"
lastUpdatedAt
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
errorDetail
— (map
)The details of an error associated a group status.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
statusHistory
— (Array<map>
)The status history of the group.
status
— (String
)The status of a group.
Possible values include:"FAILED"
"SUCCEEDED"
"PROCESSING"
"DELETING"
"DELETED"
lastUpdatedAt
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
errorDetail
— (map
)The details of an error associated a group status.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
-
(AWS.Response)
—
Returns:
getIndex(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business index.
Service Reference:
Examples:
Calling the getIndex operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.getIndex(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application connected to the index.
indexId
— (String
)The identifier of the Amazon Q Business index you want information on.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:applicationId
— (String
)The identifier of the Amazon Q Business application associated with the index.
indexId
— (String
)The identifier of the Amazon Q Business index.
displayName
— (String
)The name of the Amazon Q Business index.
type
— (String
)The type of index attached to your Amazon Q Business application.
Possible values include:"ENTERPRISE"
"STARTER"
indexArn
— (String
)The Amazon Resource Name (ARN) of the Amazon Q Business index.
status
— (String
)The current status of the index. When the value is
Possible values include:ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why."CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
description
— (String
)The description for the Amazon Q Business index.
createdAt
— (Date
)The Unix timestamp when the Amazon Q Business index was created.
updatedAt
— (Date
)The Unix timestamp when the Amazon Q Business index was last updated.
capacityConfiguration
— (map
)The storage capacity units chosen for your Amazon Q Business index.
units
— (Integer
)The number of storage units configured for an Amazon Q Business index.
documentAttributeConfigurations
— (Array<map>
)Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
name
— (String
)The name of the document attribute.
type
— (String
)The type of document attribute.
Possible values include:"STRING"
"STRING_LIST"
"NUMBER"
"DATE"
search
— (String
)Information about whether the document attribute can be used by an end user to search for information on their web experience.
Possible values include:"ENABLED"
"DISABLED"
error
— (map
)When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why.errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
indexStatistics
— (map
)Provides information about the number of documents indexed.
textDocumentStatistics
— (map
)The number of documents indexed.
indexedTextBytes
— (Integer
)The total size, in bytes, of the indexed documents.
indexedTextDocumentCount
— (Integer
)The number of text documents indexed.
-
(AWS.Response)
—
Returns:
getPlugin(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business plugin.
Service Reference:
Examples:
Calling the getPlugin operation
var params = { applicationId: 'STRING_VALUE', /* required */ pluginId: 'STRING_VALUE' /* required */ }; qbusiness.getPlugin(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application which contains the plugin.
pluginId
— (String
)The identifier of the plugin.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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.
Possible values include:"SERVICE_NOW"
"SALESFORCE"
"JIRA"
"ZENDESK"
"CUSTOM"
serverUrl
— (String
)The source URL used for plugin configuration.
authConfiguration
— (map
)Authentication configuration information for an Amazon Q Business plugin.
basicAuthConfiguration
— (map
)Information about the basic authentication credentials used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn
— required — (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
— (map
)Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn
— required — (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.
noAuthConfiguration
— (map
)Information about invoking a custom plugin without any authentication.
customPluginConfiguration
— (map
)Configuration information required to create a custom plugin.
description
— required — (String
)A description for your custom plugin configuration.
apiSchemaType
— required — (String
)The type of OpenAPI schema to use.
Possible values include:"OPEN_API_V3"
apiSchema
— required — (map
)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
— (map
)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
— required — (String
)The name of the S3 bucket that contains the file.
key
— required — (String
)The name of the file.
buildStatus
— (String
)The current status of a plugin. A plugin is modified asynchronously.
Possible values include:"READY"
"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
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.
Possible values include:"ENABLED"
"DISABLED"
createdAt
— (Date
)The timestamp for when the plugin was created.
updatedAt
— (Date
)The timestamp for when the plugin was last updated.
-
(AWS.Response)
—
Returns:
getRetriever(params = {}, callback) ⇒ AWS.Request
Gets information about an existing retriever used by an Amazon Q Business application.
Service Reference:
Examples:
Calling the getRetriever operation
var params = { applicationId: 'STRING_VALUE', /* required */ retrieverId: 'STRING_VALUE' /* required */ }; qbusiness.getRetriever(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application using the retriever.
retrieverId
— (String
)The identifier of the retriever.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:applicationId
— (String
)The identifier of the Amazon Q Business application using the retriever.
retrieverId
— (String
)The identifier of the retriever.
retrieverArn
— (String
)The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
type
— (String
)The type of the retriever.
Possible values include:"NATIVE_INDEX"
"KENDRA_INDEX"
status
— (String
)The status of the retriever.
Possible values include:"CREATING"
"ACTIVE"
"FAILED"
displayName
— (String
)The name of the retriever.
configuration
— (map
)Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration
— (map
)Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier for the Amazon Q Business index.
boostingOverride
— (map<map>
)Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
numberConfiguration
— (map
)Provides information on boosting
NUMBER
type document attributes.boostingLevel
— required — (String
)Specifies the duration, in seconds, of a boost applies to a
Possible values include:NUMBER
type document attribute."NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingType
— (String
)Specifies how much a document attribute is boosted.
Possible values include:"PRIORITIZE_LARGER_VALUES"
"PRIORITIZE_SMALLER_VALUES"
stringConfiguration
— (map
)Provides information on boosting
STRING
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
attributeValueBoosting
— (map<String>
)Specifies specific values of a
STRING
type document attribute being boosted.
dateConfiguration
— (map
)Provides information on boosting
DATE
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingDurationInSeconds
— (Integer
)Specifies the duration, in seconds, of a boost applies to a
DATE
type document attribute.
stringListConfiguration
— (map
)Provides information on boosting
STRING_LIST
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
kendraIndexConfiguration
— (map
)Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier of the Amazon Kendra index.
roleArn
— (String
)The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
createdAt
— (Date
)The Unix timestamp when the retriever was created.
updatedAt
— (Date
)The Unix timestamp when the retriever was last updated.
-
(AWS.Response)
—
Returns:
getUser(params = {}, callback) ⇒ AWS.Request
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Service Reference:
Examples:
Calling the getUser operation
var params = { applicationId: 'STRING_VALUE', /* required */ userId: 'STRING_VALUE' /* required */ }; qbusiness.getUser(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application connected to the user.
userId
— (String
)The user email address attached to the user.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:userAliases
— (Array<map>
)A list of user aliases attached to a user.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
-
(AWS.Response)
—
Returns:
getWebExperience(params = {}, callback) ⇒ AWS.Request
Gets information about an existing Amazon Q Business web experience.
Service Reference:
Examples:
Calling the getWebExperience operation
var params = { applicationId: 'STRING_VALUE', /* required */ webExperienceId: 'STRING_VALUE' /* required */ }; qbusiness.getWebExperience(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
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.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
Possible values include:Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail."CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"PENDING_AUTH_CONFIG"
createdAt
— (Date
)The Unix timestamp when the Amazon Q Business web experience was last created.
updatedAt
— (Date
)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.
Possible values include:"ENABLED"
"DISABLED"
roleArn
— (String
)The Amazon Resource Name (ARN) of the service role attached to your web experience.
authenticationConfiguration
— (map
)The authentication configuration information for your Amazon Q Business web experience.
samlConfiguration
— (map
)Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
metadataXML
— required — (String
)The metadata XML that your IdP generated.
roleArn
— required — (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
— required — (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
— (map
)When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
-
(AWS.Response)
—
Returns:
listApplications(params = {}, callback) ⇒ AWS.Request
Lists Amazon Q Business applications.
Service Reference:
Examples:
Calling the listApplications operation
var params = { maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listApplications(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.maxResults
— (Integer
)The maximum number of Amazon Q Business applications to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (Array<map>
)An array of summary information on the configuration of one or more Amazon Q Business applications.
displayName
— (String
)The name of the Amazon Q Business application.
applicationId
— (String
)The identifier for the Amazon Q Business application.
createdAt
— (Date
)The Unix timestamp when the Amazon Q Business application was created.
updatedAt
— (Date
)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
Possible values include:ACTIVE
."CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
-
(AWS.Response)
—
Returns:
listConversations(params = {}, callback) ⇒ AWS.Request
Lists one or more Amazon Q Business conversations.
Service Reference:
Examples:
Calling the listConversations operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', userId: 'STRING_VALUE' }; qbusiness.listConversations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
userId
— (String
)The identifier of the user involved in the Amazon Q Business web experience conversation.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.maxResults
— (Integer
)The maximum number of Amazon Q Business conversations to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
conversations
— (Array<map>
)An array of summary information on the configuration of one or more Amazon Q Business web experiences.
conversationId
— (String
)The identifier of the Amazon Q Business conversation.
title
— (String
)The title of the conversation.
startTime
— (Date
)The start time of the conversation.
-
(AWS.Response)
—
Returns:
listDataSources(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Q Business data source connectors that you have created.
Service Reference:
Examples:
Calling the listDataSources operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listDataSources(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application linked to the data source connectors.
indexId
— (String
)The identifier of the index used with one or more data source connectors.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.maxResults
— (Integer
)The maximum number of data source connectors to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dataSources
— (Array<map>
)An array of summary information for one or more data source connector.
displayName
— (String
)The name of the Amazon Q Business data source.
dataSourceId
— (String
)The identifier of the Amazon Q Business data source.
type
— (String
)The type of the Amazon Q Business data source.
createdAt
— (Date
)The Unix timestamp when the Amazon Q Business data source was created.
updatedAt
— (Date
)The Unix timestamp when the Amazon Q Business data source was last updated.
status
— (String
)The status of the Amazon Q Business data source.
Possible values include:"PENDING_CREATION"
"CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
-
(AWS.Response)
—
Returns:
listDataSourceSyncJobs(params = {}, callback) ⇒ AWS.Request
Get information about an Amazon Q Business data source connector synchronization.
Service Reference:
Examples:
Calling the listDataSourceSyncJobs operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, statusFilter: FAILED | SUCCEEDED | SYNCING | INCOMPLETE | STOPPING | ABORTED | SYNCING_INDEXING }; qbusiness.listDataSourceSyncJobs(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
dataSourceId
— (String
)The identifier of the data source connector.
applicationId
— (String
)The identifier of the Amazon Q Business application connected to the data source.
indexId
— (String
)The identifier of the index used with the Amazon Q Business data source connector.
nextToken
— (String
)If the
maxResults
response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.maxResults
— (Integer
)The maximum number of synchronization jobs to return in the response.
startTime
— (Date
)The start time of the data source connector sync.
endTime
— (Date
)The end time of the data source connector sync.
statusFilter
— (String
)Only returns synchronization jobs with the
Possible values include:Status
field equal to the specified status."FAILED"
"SUCCEEDED"
"SYNCING"
"INCOMPLETE"
"STOPPING"
"ABORTED"
"SYNCING_INDEXING"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:history
— (Array<map>
)A history of synchronization jobs for the data source connector.
executionId
— (String
)The identifier of a data source synchronization job.
startTime
— (Date
)The Unix time stamp when the data source synchronization job started.
endTime
— (Date
)The Unix timestamp when the synchronization job completed.
status
— (String
)The status of the synchronization job. When the
Possible values include:Status
field is set toSUCCEEDED
, the synchronization job is done. If the status code isFAILED
, theErrorCode
andErrorMessage
fields give you the reason for the failure."FAILED"
"SUCCEEDED"
"SYNCING"
"INCOMPLETE"
"STOPPING"
"ABORTED"
"SYNCING_INDEXING"
error
— (map
)If the
Status
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
dataSourceErrorCode
— (String
)If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
metrics
— (map
)Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
documentsAdded
— (String
)The current count of documents added from the data source during the data source sync.
documentsModified
— (String
)The current count of documents modified in the data source during the data source sync.
documentsDeleted
— (String
)The current count of documents deleted from the data source during the data source sync.
documentsFailed
— (String
)The current count of documents that failed to sync from the data source during the data source sync.
documentsScanned
— (String
)The current count of documents crawled by the ongoing sync job in the data source.
nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
-
(AWS.Response)
—
Returns:
listDocuments(params = {}, callback) ⇒ AWS.Request
A list of documents attached to an index.
Service Reference:
Examples:
Calling the listDocuments operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ dataSourceIds: [ 'STRING_VALUE', /* more items */ ], maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listDocuments(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application id the documents are attached to.
indexId
— (String
)The identifier of the index the documents are attached to.
dataSourceIds
— (Array<String>
)The identifier of the data sources the documents are attached to.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.maxResults
— (Integer
)The maximum number of documents to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:documentDetailList
— (Array<map>
)A list of document details.
documentId
— (String
)The identifier of the document.
status
— (String
)The current status of the document.
Possible values include:"RECEIVED"
"PROCESSING"
"INDEXED"
"UPDATED"
"FAILED"
"DELETING"
"DELETED"
"DOCUMENT_FAILED_TO_INDEX"
error
— (map
)An error message associated with the document.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
createdAt
— (Date
)The timestamp for when the document was created.
updatedAt
— (Date
)The timestamp for when the document was last updated.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
-
(AWS.Response)
—
Returns:
listGroups(params = {}, callback) ⇒ AWS.Request
Provides a list of groups that are mapped to users.
Service Reference:
Examples:
Calling the listGroups operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ updatedEarlierThan: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ dataSourceId: 'STRING_VALUE', maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listGroups(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application for getting a list of groups mapped to users.
indexId
— (String
)The identifier of the index for getting a list of groups mapped to users.
updatedEarlierThan
— (Date
)The timestamp identifier used for the latest
PUT
orDELETE
action for mapping users to their groups.dataSourceId
— (String
)The identifier of the data source for getting a list of groups mapped to users.
nextToken
— (String
)If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
maxResults
— (Integer
)The maximum number of returned groups that are mapped to users.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
items
— (Array<map>
)Summary information for list of groups that are mapped to users.
groupName
— (String
)The name of the group the summary information is for.
-
(AWS.Response)
—
Returns:
listIndices(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Q Business indices you have created.
Service Reference:
Examples:
Calling the listIndices operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listIndices(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application connected to the index.
nextToken
— (String
)If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
maxResults
— (Integer
)The maximum number of indices to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
indices
— (Array<map>
)An array of information on the items in one or more indexes.
displayName
— (String
)The name of the index.
indexId
— (String
)The identifier for the index.
createdAt
— (Date
)The Unix timestamp when the index was created.
updatedAt
— (Date
)The Unix timestamp when the index was last updated.
status
— (String
)The current status of the index. When the status is
Possible values include:ACTIVE
, the index is ready."CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"UPDATING"
-
(AWS.Response)
—
Returns:
listMessages(params = {}, callback) ⇒ AWS.Request
Gets a list of messages associated with an Amazon Q Business web experience.
Service Reference:
Examples:
Calling the listMessages operation
var params = { applicationId: 'STRING_VALUE', /* required */ conversationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE', userId: 'STRING_VALUE' }; qbusiness.listMessages(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
conversationId
— (String
)The identifier of the Amazon Q Business web experience conversation.
applicationId
— (String
)The identifier for the Amazon Q Business application.
userId
— (String
)The identifier of the user involved in the Amazon Q Business web experience conversation.
nextToken
— (String
)If the number of retrievers returned exceeds
maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.maxResults
— (Integer
)The maximum number of messages to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:messages
— (Array<map>
)An array of information on one or more messages.
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
— (Date
)The timestamp of the first Amazon Q Business web experience message.
type
— (String
)The type of Amazon Q Business message, whether
Possible values include:HUMAN
orAI
generated."USER"
"SYSTEM"
attachments
— (Array<map>
)A file directly uploaded into an Amazon Q Business web experience chat.
name
— (String
)The name of a file uploaded during chat.
status
— (String
)The status of a file uploaded during chat.
Possible values include:"FAILED"
"SUCCEEDED"
error
— (map
)An error associated with a file uploaded during chat.
errorMessage
— (String
)The message explaining the data source sync error.
errorCode
— (String
)The code associated with the data source sync error.
Possible values include:"InternalError"
"InvalidRequest"
"ResourceInactive"
"ResourceNotFound"
sourceAttribution
— (Array<map>
)The source documents used to generate Amazon Q Business web experience message.
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
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
textMessageSegments
— (Array<map>
)A text extract from a source document that is used for source attribution.
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
— (map
)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.
actionReview
— (map
)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.
Possible values include:"SERVICE_NOW"
"SALESFORCE"
"JIRA"
"ZENDESK"
"CUSTOM"
payload
— (map<map>
)Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
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.
Possible values include:"STRING"
"NUMBER"
"ARRAY"
"BOOLEAN"
value
— (map
)The field value.
allowedValues
— (Array<map>
)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
— (map
)The field value.
displayValue
— (map
)The name of the field.
allowedFormat
— (String
)The expected data format for the action review input field value. For example, in PTO request,
from
andto
would be ofdatetime
allowed format.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
— (map
)Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
pluginId
— required — (String
)The identifier of the plugin the action is attached to.
payload
— required — (map<map>
)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.
value
— required — (map
)The content of a user input field in an plugin action execution payload.
payloadFieldNameSeparator
— required — (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.
-
(AWS.Response)
—
Returns:
listPlugins(params = {}, callback) ⇒ AWS.Request
Lists configured Amazon Q Business plugins.
Service Reference:
Examples:
Calling the listPlugins operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listPlugins(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application the plugin is attached to.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.maxResults
— (Integer
)The maximum number of documents to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties: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
— (Array<map>
)Information about a configured plugin.
pluginId
— (String
)The identifier of the plugin.
displayName
— (String
)The name of the plugin.
type
— (String
)The type of the plugin.
Possible values include:"SERVICE_NOW"
"SALESFORCE"
"JIRA"
"ZENDESK"
"CUSTOM"
serverUrl
— (String
)The plugin server URL used for configuration.
state
— (String
)The current status of the plugin.
Possible values include:"ENABLED"
"DISABLED"
buildStatus
— (String
)The status of the plugin.
Possible values include:"READY"
"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"DELETE_IN_PROGRESS"
"DELETE_FAILED"
createdAt
— (Date
)The timestamp for when the plugin was created.
updatedAt
— (Date
)The timestamp for when the plugin was last updated.
-
(AWS.Response)
—
Returns:
listRetrievers(params = {}, callback) ⇒ AWS.Request
Lists the retriever used by an Amazon Q Business application.
Service Reference:
Examples:
Calling the listRetrievers operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listRetrievers(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application using the retriever.
nextToken
— (String
)If the number of retrievers returned exceeds
maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.maxResults
— (Integer
)The maximum number of retrievers returned.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:retrievers
— (Array<map>
)An array of summary information for one or more retrievers.
applicationId
— (String
)The identifier of the Amazon Q Business application using the retriever.
retrieverId
— (String
)The identifier of the retriever used by your Amazon Q Business application.
type
— (String
)The type of your retriever.
Possible values include:"NATIVE_INDEX"
"KENDRA_INDEX"
status
— (String
)The status of your retriever.
Possible values include:"CREATING"
"ACTIVE"
"FAILED"
displayName
— (String
)The name of your retriever.
nextToken
— (String
)If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = { resourceARN: 'STRING_VALUE' /* required */ }; qbusiness.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:tags
— (Array<map>
)A list of tags associated with the Amazon Q Business application or data source.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
-
(AWS.Response)
—
Returns:
listWebExperiences(params = {}, callback) ⇒ AWS.Request
Lists one or more Amazon Q Business Web Experiences.
Service Reference:
Examples:
Calling the listWebExperiences operation
var params = { applicationId: 'STRING_VALUE', /* required */ maxResults: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; qbusiness.listWebExperiences(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application linked to the listed web experiences.
nextToken
— (String
)If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.maxResults
— (Integer
)The maximum number of Amazon Q Business Web Experiences to return.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:webExperiences
— (Array<map>
)An array of summary information for one or more Amazon Q Business experiences.
webExperienceId
— (String
)The identifier of your Amazon Q Business web experience.
createdAt
— (Date
)The Unix timestamp when the Amazon Q Business application was last updated.
updatedAt
— (Date
)The Unix timestamp when your Amazon Q Business web experience was updated.
defaultEndpoint
— (String
)The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
status
— (String
)The status of your Amazon Q Business web experience.
Possible values include:"CREATING"
"ACTIVE"
"DELETING"
"FAILED"
"PENDING_AUTH_CONFIG"
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.
-
(AWS.Response)
—
Returns:
putFeedback(params = {}, callback) ⇒ AWS.Request
Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
Service Reference:
Examples:
Calling the putFeedback operation
var params = { applicationId: 'STRING_VALUE', /* required */ conversationId: 'STRING_VALUE', /* required */ messageId: 'STRING_VALUE', /* required */ messageCopiedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, messageUsefulness: { submittedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ usefulness: USEFUL | NOT_USEFUL, /* required */ comment: 'STRING_VALUE', reason: NOT_FACTUALLY_CORRECT | HARMFUL_OR_UNSAFE | INCORRECT_OR_MISSING_SOURCES | NOT_HELPFUL | FACTUALLY_CORRECT | COMPLETE | RELEVANT_SOURCES | HELPFUL | NOT_BASED_ON_DOCUMENTS | NOT_COMPLETE | NOT_CONCISE | OTHER }, userId: 'STRING_VALUE' }; qbusiness.putFeedback(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application associated with the feedback.
userId
— (String
)The identifier of the user giving the feedback.
conversationId
— (String
)The identifier of the conversation the feedback is attached to.
messageId
— (String
)The identifier of the chat message that the feedback was given for.
messageCopiedAt
— (Date
)The timestamp for when the feedback was recorded.
messageUsefulness
— (map
)The feedback usefulness value given by the user to the chat message.
usefulness
— required — (String
)The usefulness value assigned by an end user to a message.
Possible values include:"USEFUL"
"NOT_USEFUL"
reason
— (String
)The reason for a usefulness rating.
Possible values include:"NOT_FACTUALLY_CORRECT"
"HARMFUL_OR_UNSAFE"
"INCORRECT_OR_MISSING_SOURCES"
"NOT_HELPFUL"
"FACTUALLY_CORRECT"
"COMPLETE"
"RELEVANT_SOURCES"
"HELPFUL"
"NOT_BASED_ON_DOCUMENTS"
"NOT_COMPLETE"
"NOT_CONCISE"
"OTHER"
comment
— (String
)A comment given by an end user on the usefulness of an AI-generated chat message.
submittedAt
— required — (Date
)The timestamp for when the feedback was submitted.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
putGroup(params = {}, callback) ⇒ AWS.Request
Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.
Service Reference:
Examples:
Calling the putGroup operation
var params = { applicationId: 'STRING_VALUE', /* required */ groupMembers: { /* required */ memberGroups: [ { groupName: 'STRING_VALUE', /* required */ type: INDEX | DATASOURCE }, /* more items */ ], memberUsers: [ { userId: 'STRING_VALUE', /* required */ type: INDEX | DATASOURCE }, /* more items */ ] }, groupName: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ type: INDEX | DATASOURCE, /* required */ dataSourceId: 'STRING_VALUE' }; qbusiness.putGroup(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application in which the user and group mapping belongs.
indexId
— (String
)The identifier of the index in which you want to map users to their groups.
groupName
— (String
)The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
dataSourceId
— (String
)The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.
type
— (String
)The type of the group.
Possible values include:"INDEX"
"DATASOURCE"
groupMembers
— (map
)A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.
memberGroups
— (Array<map>
)A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
groupName
— required — (String
)The name of the sub group.
type
— (String
)The type of the sub group.
Possible values include:"INDEX"
"DATASOURCE"
memberUsers
— (Array<map>
)A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
userId
— required — (String
)The identifier of the user you want to map to a group.
type
— (String
)The type of the user.
Possible values include:"INDEX"
"DATASOURCE"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
startDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a
ConflictException
.Service Reference:
Examples:
Calling the startDataSourceSyncJob operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.startDataSourceSyncJob(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
dataSourceId
— (String
)The identifier of the data source connector.
applicationId
— (String
)The identifier of Amazon Q Business application the data source is connected to.
indexId
— (String
)The identifier of the index used with the data source connector.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:executionId
— (String
)The identifier for a particular synchronization job.
-
(AWS.Response)
—
Returns:
stopDataSourceSyncJob(params = {}, callback) ⇒ AWS.Request
Stops an Amazon Q Business data source connector synchronization job already in progress.
Service Reference:
Examples:
Calling the stopDataSourceSyncJob operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE' /* required */ }; qbusiness.stopDataSourceSyncJob(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
dataSourceId
— (String
)The identifier of the data source connector.
applicationId
— (String
)The identifier of the Amazon Q Business application that the data source is connected to.
indexId
— (String
)The identifier of the index used with the Amazon Q Business data source connector.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
Service Reference:
Examples:
Calling the tagResource operation
var params = { resourceARN: 'STRING_VALUE', /* required */ tags: [ /* required */ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; qbusiness.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
tags
— (Array<map>
)A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.
key
— required — (String
)The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value
— required — (String
)The value associated with the tag. The value may be an empty string but it can't be null.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes a tag from an Amazon Q Business application or a data source.
Service Reference:
Examples:
Calling the untagResource operation
var params = { resourceARN: 'STRING_VALUE', /* required */ tagKeys: [ /* required */ 'STRING_VALUE', /* more items */ ] }; qbusiness.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceARN
— (String
)The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
tagKeys
— (Array<String>
)A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateApplication(params = {}, callback) ⇒ AWS.Request
Updates an existing Amazon Q Business application.
Service Reference:
Examples:
Calling the updateApplication operation
var params = { applicationId: 'STRING_VALUE', /* required */ attachmentsConfiguration: { attachmentsControlMode: ENABLED | DISABLED /* required */ }, description: 'STRING_VALUE', displayName: 'STRING_VALUE', identityCenterInstanceArn: 'STRING_VALUE', personalizationConfiguration: { personalizationControlMode: ENABLED | DISABLED /* required */ }, qAppsConfiguration: { qAppsControlMode: ENABLED | DISABLED /* required */ }, roleArn: 'STRING_VALUE' }; qbusiness.updateApplication(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application.
identityCenterInstanceArn
— (String
)The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
displayName
— (String
)A name for the Amazon Q Business application.
description
— (String
)A description for the Amazon Q Business application.
roleArn
— (String
)An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
attachmentsConfiguration
— (map
)An option to allow end users to upload files directly during chat.
attachmentsControlMode
— required — (String
)Status information about whether file upload functionality is activated or deactivated for your end user.
Possible values include:"ENABLED"
"DISABLED"
qAppsConfiguration
— (map
)An option to allow end users to create and use Amazon Q Apps in the web experience.
qAppsControlMode
— required — (String
)Status information about whether end users can create and use Amazon Q Apps in the web experience.
Possible values include:"ENABLED"
"DISABLED"
personalizationConfiguration
— (map
)Configuration information about chat response personalization. For more information, see Personalizing chat responses.
personalizationControlMode
— required — (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.
Possible values include:"ENABLED"
"DISABLED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateChatControlsConfiguration(params = {}, callback) ⇒ AWS.Request
Updates an set of chat controls configured for an existing Amazon Q Business application.
Service Reference:
Examples:
Calling the updateChatControlsConfiguration operation
var params = { applicationId: 'STRING_VALUE', /* required */ blockedPhrasesConfigurationUpdate: { blockedPhrasesToCreateOrUpdate: [ 'STRING_VALUE', /* more items */ ], blockedPhrasesToDelete: [ 'STRING_VALUE', /* more items */ ], systemMessageOverride: 'STRING_VALUE' }, clientToken: 'STRING_VALUE', creatorModeConfiguration: { creatorModeControl: ENABLED | DISABLED /* required */ }, responseScope: ENTERPRISE_CONTENT_ONLY | EXTENDED_KNOWLEDGE_ENABLED, topicConfigurationsToCreateOrUpdate: [ { name: 'STRING_VALUE', /* required */ rules: [ /* required */ { ruleType: CONTENT_BLOCKER_RULE | CONTENT_RETRIEVAL_RULE, /* required */ excludedUsersAndGroups: { userGroups: [ 'STRING_VALUE', /* more items */ ], userIds: [ 'STRING_VALUE', /* more items */ ] }, includedUsersAndGroups: { userGroups: [ 'STRING_VALUE', /* more items */ ], userIds: [ 'STRING_VALUE', /* more items */ ] }, ruleConfiguration: { contentBlockerRule: { systemMessageOverride: 'STRING_VALUE' }, contentRetrievalRule: { eligibleDataSources: [ { dataSourceId: 'STRING_VALUE', indexId: 'STRING_VALUE' }, /* more items */ ] } } }, /* more items */ ], description: 'STRING_VALUE', exampleChatMessages: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], topicConfigurationsToDelete: [ { name: 'STRING_VALUE', /* required */ rules: [ /* required */ { ruleType: CONTENT_BLOCKER_RULE | CONTENT_RETRIEVAL_RULE, /* required */ excludedUsersAndGroups: { userGroups: [ 'STRING_VALUE', /* more items */ ], userIds: [ 'STRING_VALUE', /* more items */ ] }, includedUsersAndGroups: { userGroups: [ 'STRING_VALUE', /* more items */ ], userIds: [ 'STRING_VALUE', /* more items */ ] }, ruleConfiguration: { contentBlockerRule: { systemMessageOverride: 'STRING_VALUE' }, contentRetrievalRule: { eligibleDataSources: [ { dataSourceId: 'STRING_VALUE', indexId: 'STRING_VALUE' }, /* more items */ ] } } }, /* more items */ ], description: 'STRING_VALUE', exampleChatMessages: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ] }; qbusiness.updateChatControlsConfiguration(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application for which the chat controls are configured.
clientToken
— (String
)A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
If a token is not provided, the SDK will use a version 4 UUID.responseScope
— (String
)The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
Possible values include:"ENTERPRISE_CONTENT_ONLY"
"EXTENDED_KNOWLEDGE_ENABLED"
blockedPhrasesConfigurationUpdate
— (map
)The phrases blocked from chat by your chat control configuration.
blockedPhrasesToCreateOrUpdate
— (Array<String>
)Creates or updates a blocked phrases configuration in your Amazon Q Business application.
blockedPhrasesToDelete
— (Array<String>
)Deletes a blocked phrases configuration in your Amazon Q Business application.
systemMessageOverride
— (String
)The configured custom message displayed to your end user when they use blocked phrase during chat.
topicConfigurationsToCreateOrUpdate
— (Array<map>
)The configured topic specific chat controls you want to update.
name
— required — (String
)A name for your topic control configuration.
description
— (String
)A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
exampleChatMessages
— (Array<String>
)A list of example phrases that you expect the end user to use in relation to the topic.
rules
— required — (Array<map>
)Rules defined for a topic configuration.
includedUsersAndGroups
— (map
)Users and groups to be included in a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
excludedUsersAndGroups
— (map
)Users and groups to be excluded from a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
ruleType
— required — (String
)The type of rule.
Possible values include:"CONTENT_BLOCKER_RULE"
"CONTENT_RETRIEVAL_RULE"
ruleConfiguration
— (map
)The configuration information for a rule.
contentBlockerRule
— (map
)A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
systemMessageOverride
— (String
)The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
contentRetrievalRule
— (map
)Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
eligibleDataSources
— (Array<map>
)Specifies data sources in a Amazon Q Business application to use for content generation.
indexId
— (String
)The identifier of the index the data source is attached to.
dataSourceId
— (String
)The identifier of the data source.
topicConfigurationsToDelete
— (Array<map>
)The configured topic specific chat controls you want to delete.
name
— required — (String
)A name for your topic control configuration.
description
— (String
)A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
exampleChatMessages
— (Array<String>
)A list of example phrases that you expect the end user to use in relation to the topic.
rules
— required — (Array<map>
)Rules defined for a topic configuration.
includedUsersAndGroups
— (map
)Users and groups to be included in a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
excludedUsersAndGroups
— (map
)Users and groups to be excluded from a rule.
userIds
— (Array<String>
)The user ids associated with a topic control rule.
userGroups
— (Array<String>
)The user groups associated with a topic control rule.
ruleType
— required — (String
)The type of rule.
Possible values include:"CONTENT_BLOCKER_RULE"
"CONTENT_RETRIEVAL_RULE"
ruleConfiguration
— (map
)The configuration information for a rule.
contentBlockerRule
— (map
)A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
systemMessageOverride
— (String
)The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
contentRetrievalRule
— (map
)Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
eligibleDataSources
— (Array<map>
)Specifies data sources in a Amazon Q Business application to use for content generation.
indexId
— (String
)The identifier of the index the data source is attached to.
dataSourceId
— (String
)The identifier of the data source.
creatorModeConfiguration
— (map
)The configuration details for
CREATOR_MODE
.creatorModeControl
— required — (String
)Status information about whether
Possible values include:CREATOR_MODE
has been enabled or disabled. The default status isDISABLED
."ENABLED"
"DISABLED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateDataSource(params = {}, callback) ⇒ AWS.Request
Updates an existing Amazon Q Business data source connector.
Service Reference:
Examples:
Calling the updateDataSource operation
var params = { applicationId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ configuration: { }, description: 'STRING_VALUE', displayName: 'STRING_VALUE', documentEnrichmentConfiguration: { inlineConfigurations: [ { condition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, documentContentOperator: DELETE, target: { key: 'STRING_VALUE', /* required */ attributeValueOperator: DELETE, value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } } }, /* more items */ ], postExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' }, preExtractionHookConfiguration: { invocationCondition: { key: 'STRING_VALUE', /* required */ operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */ value: { dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, longValue: 'NUMBER_VALUE', stringListValue: [ 'STRING_VALUE', /* more items */ ], stringValue: 'STRING_VALUE' } }, lambdaArn: 'STRING_VALUE', roleArn: 'STRING_VALUE', s3BucketName: 'STRING_VALUE' } }, roleArn: 'STRING_VALUE', syncSchedule: 'STRING_VALUE', vpcConfiguration: { securityGroupIds: [ /* required */ 'STRING_VALUE', /* more items */ ], subnetIds: [ /* required */ 'STRING_VALUE', /* more items */ ] } }; qbusiness.updateDataSource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application the data source is attached to.
indexId
— (String
)The identifier of the index attached to the data source connector.
dataSourceId
— (String
)The identifier of the data source connector.
displayName
— (String
)A name of the data source connector.
configuration
— (map
)Provides the configuration information for an Amazon Q Business data source.
vpcConfiguration
— (map
)Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
subnetIds
— required — (Array<String>
)A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
securityGroupIds
— required — (Array<String>
)A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
description
— (String
)The description of the data source connector.
syncSchedule
— (String
)The chosen update frequency for your data source.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
documentEnrichmentConfiguration
— (map
)Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
inlineConfigurations
— (Array<map>
)Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
condition
— (map
)The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with
DocumentAttributeTarget
to apply the condition.For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
target
— (map
)The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to
TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using
DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.You can also use this with
DocumentAttributeCondition
.key
— required — (String
)The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
attributeValueOperator
— (String
)TRUE
to delete the existing target value for your specified target attribute key. You cannot create a target value and set this toTRUE
."DELETE"
documentContentOperator
— (String
)TRUE
to delete content if the condition used for the target attribute is met."DELETE"
preExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
postExtractionHookConfiguration
— (map
)Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration
parameter if you want to apply advanced alterations on the original or raw documents.If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration
.You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
invocationCondition
— (map
)The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
key
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support
_document_body
as an attribute key used for the condition.operator
— required — (String
)The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support
Possible values include:_document_body
as an attribute key used for the condition."GREATER_THAN"
"GREATER_THAN_OR_EQUALS"
"LESS_THAN"
"LESS_THAN_OR_EQUALS"
"EQUALS"
"NOT_EQUALS"
"CONTAINS"
"NOT_CONTAINS"
"EXISTS"
"NOT_EXISTS"
"BEGINS_WITH"
value
— (map
)The value of a document attribute. You can only provide one value for a document attribute.
stringValue
— (String
)A string.
stringListValue
— (Array<String>
)A list of strings.
longValue
— (Integer
)A long integer value.
dateValue
— (Date
)A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lambdaArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
s3BucketName
— (String
)Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
roleArn
— (String
)The Amazon Resource Name (ARN) of a role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateIndex(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business index.
Service Reference:
Examples:
Calling the updateIndex operation
var params = { applicationId: 'STRING_VALUE', /* required */ indexId: 'STRING_VALUE', /* required */ capacityConfiguration: { units: 'NUMBER_VALUE' }, description: 'STRING_VALUE', displayName: 'STRING_VALUE', documentAttributeConfigurations: [ { name: 'STRING_VALUE', search: ENABLED | DISABLED, type: STRING | STRING_LIST | NUMBER | DATE }, /* more items */ ] }; qbusiness.updateIndex(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application connected to the index.
indexId
— (String
)The identifier of the Amazon Q Business index.
displayName
— (String
)The name of the Amazon Q Business index.
description
— (String
)The description of the Amazon Q Business index.
capacityConfiguration
— (map
)The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
units
— (Integer
)The number of storage units configured for an Amazon Q Business index.
documentAttributeConfigurations
— (Array<map>
)Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
name
— (String
)The name of the document attribute.
type
— (String
)The type of document attribute.
Possible values include:"STRING"
"STRING_LIST"
"NUMBER"
"DATE"
search
— (String
)Information about whether the document attribute can be used by an end user to search for information on their web experience.
Possible values include:"ENABLED"
"DISABLED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updatePlugin(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business plugin.
Service Reference:
Examples:
Calling the updatePlugin operation
var params = { applicationId: 'STRING_VALUE', /* required */ pluginId: 'STRING_VALUE', /* required */ authConfiguration: { basicAuthConfiguration: { roleArn: 'STRING_VALUE', /* required */ secretArn: 'STRING_VALUE' /* required */ }, noAuthConfiguration: { }, oAuth2ClientCredentialConfiguration: { roleArn: 'STRING_VALUE', /* required */ secretArn: 'STRING_VALUE' /* required */ } }, customPluginConfiguration: { apiSchema: { /* required */ payload: 'STRING_VALUE', s3: { bucket: 'STRING_VALUE', /* required */ key: 'STRING_VALUE' /* required */ } }, apiSchemaType: OPEN_API_V3, /* required */ description: 'STRING_VALUE' /* required */ }, displayName: 'STRING_VALUE', serverUrl: 'STRING_VALUE', state: ENABLED | DISABLED }; qbusiness.updatePlugin(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application the plugin is attached to.
pluginId
— (String
)The identifier of the plugin.
displayName
— (String
)The name of the plugin.
state
— (String
)The status of the plugin.
Possible values include:"ENABLED"
"DISABLED"
serverUrl
— (String
)The source URL used for plugin configuration.
customPluginConfiguration
— (map
)The configuration for a custom plugin.
description
— required — (String
)A description for your custom plugin configuration.
apiSchemaType
— required — (String
)The type of OpenAPI schema to use.
Possible values include:"OPEN_API_V3"
apiSchema
— required — (map
)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
— (map
)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
— required — (String
)The name of the S3 bucket that contains the file.
key
— required — (String
)The name of the file.
authConfiguration
— (map
)The authentication configuration the plugin is using.
basicAuthConfiguration
— (map
)Information about the basic authentication credentials used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
roleArn
— required — (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
— (map
)Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
secretArn
— required — (String
)The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
roleArn
— required — (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.
noAuthConfiguration
— (map
)Information about invoking a custom plugin without any authentication.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateRetriever(params = {}, callback) ⇒ AWS.Request
Updates the retriever used for your Amazon Q Business application.
Service Reference:
Examples:
Calling the updateRetriever operation
var params = { applicationId: 'STRING_VALUE', /* required */ retrieverId: 'STRING_VALUE', /* required */ configuration: { kendraIndexConfiguration: { indexId: 'STRING_VALUE' /* required */ }, nativeIndexConfiguration: { indexId: 'STRING_VALUE', /* required */ boostingOverride: { '<DocumentAttributeKey>': { dateConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ boostingDurationInSeconds: 'NUMBER_VALUE' }, numberConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ boostingType: PRIORITIZE_LARGER_VALUES | PRIORITIZE_SMALLER_VALUES }, stringConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */ attributeValueBoosting: { '<String>': LOW | MEDIUM | HIGH | VERY_HIGH, /* '<String>': ... */ } }, stringListConfiguration: { boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH /* required */ } }, /* '<DocumentAttributeKey>': ... */ } } }, displayName: 'STRING_VALUE', roleArn: 'STRING_VALUE' }; qbusiness.updateRetriever(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of your Amazon Q Business application.
retrieverId
— (String
)The identifier of your retriever.
configuration
— (map
)Provides information on how the retriever used for your Amazon Q Business application is configured.
nativeIndexConfiguration
— (map
)Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier for the Amazon Q Business index.
boostingOverride
— (map<map>
)Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
numberConfiguration
— (map
)Provides information on boosting
NUMBER
type document attributes.boostingLevel
— required — (String
)Specifies the duration, in seconds, of a boost applies to a
Possible values include:NUMBER
type document attribute."NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingType
— (String
)Specifies how much a document attribute is boosted.
Possible values include:"PRIORITIZE_LARGER_VALUES"
"PRIORITIZE_SMALLER_VALUES"
stringConfiguration
— (map
)Provides information on boosting
STRING
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
attributeValueBoosting
— (map<String>
)Specifies specific values of a
STRING
type document attribute being boosted.
dateConfiguration
— (map
)Provides information on boosting
DATE
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
boostingDurationInSeconds
— (Integer
)Specifies the duration, in seconds, of a boost applies to a
DATE
type document attribute.
stringListConfiguration
— (map
)Provides information on boosting
STRING_LIST
type document attributes.boostingLevel
— required — (String
)Specifies how much a document attribute is boosted.
Possible values include:"NONE"
"LOW"
"MEDIUM"
"HIGH"
"VERY_HIGH"
kendraIndexConfiguration
— (map
)Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
indexId
— required — (String
)The identifier of the Amazon Kendra index.
displayName
— (String
)The name of your retriever.
roleArn
— (String
)The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateUser(params = {}, callback) ⇒ AWS.Request
Updates a information associated with a user id.
Service Reference:
Examples:
Calling the updateUser operation
var params = { applicationId: 'STRING_VALUE', /* required */ userId: 'STRING_VALUE', /* required */ userAliasesToDelete: [ { userId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', indexId: 'STRING_VALUE' }, /* more items */ ], userAliasesToUpdate: [ { userId: 'STRING_VALUE', /* required */ dataSourceId: 'STRING_VALUE', indexId: 'STRING_VALUE' }, /* more items */ ] }; qbusiness.updateUser(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the application the user is attached to.
userId
— (String
)The email id attached to the user.
userAliasesToUpdate
— (Array<map>
)The user aliases attached to the user id that are to be updated.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
userAliasesToDelete
— (Array<map>
)The user aliases attached to the user id that are to be deleted.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:userAliasesAdded
— (Array<map>
)The user aliases that have been to be added to a user id.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
userAliasesUpdated
— (Array<map>
)The user aliases attached to a user id that have been updated.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
userAliasesDeleted
— (Array<map>
)The user aliases that have been deleted from a user id.
indexId
— (String
)The identifier of the index that the user aliases are associated with.
dataSourceId
— (String
)The identifier of the data source that the user aliases are associated with.
userId
— required — (String
)The identifier of the user id associated with the user aliases.
-
(AWS.Response)
—
Returns:
updateWebExperience(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Q Business web experience.
Service Reference:
Examples:
Calling the updateWebExperience operation
var params = { applicationId: 'STRING_VALUE', /* required */ webExperienceId: 'STRING_VALUE', /* required */ authenticationConfiguration: { samlConfiguration: { metadataXML: 'STRING_VALUE', /* required */ roleArn: 'STRING_VALUE', /* required */ userIdAttribute: 'STRING_VALUE', /* required */ userGroupAttribute: 'STRING_VALUE' } }, roleArn: 'STRING_VALUE', samplePromptsControlMode: ENABLED | DISABLED, subtitle: 'STRING_VALUE', title: 'STRING_VALUE', welcomeMessage: 'STRING_VALUE' }; qbusiness.updateWebExperience(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
applicationId
— (String
)The identifier of the Amazon Q Business application attached to the web experience.
webExperienceId
— (String
)The identifier of the Amazon Q Business web experience.
roleArn
— (String
)The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
authenticationConfiguration
— (map
)The authentication configuration of the Amazon Q Business web experience.
samlConfiguration
— (map
)Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
metadataXML
— required — (String
)The metadata XML that your IdP generated.
roleArn
— required — (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
— required — (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.
title
— (String
)The title of the Amazon Q Business web experience.
subtitle
— (String
)The subtitle of the Amazon Q Business web experience.
welcomeMessage
— (String
)A customized welcome message for an end user in an Amazon Q Business web experience.
samplePromptsControlMode
— (String
)Determines whether sample prompts are enabled in the web experience for an end user.
Possible values include:"ENABLED"
"DISABLED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given QBusiness resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.
Parameters:
-
state
(String)
—
the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.
-
params
(map)
(defaults to: {})
—
a list of parameters for the given state. See each waiter resource state for required parameters.
Callback (callback):
-
function(err, data) { ... }
Callback containing error and data information. See the respective resource state for the expected error or data information.
If the waiter times out its requests, it will return a
ResourceNotReady
error.
Returns:
Generated on Thu Aug 22 18:45:13 2024 by yard 0.9.36 (ruby-2.5.1). - createDataSource(params = {}, callback) ⇒ AWS.Request