AppIntegrationsConfiguration
Configuration information for Amazon AppIntegrations to automatically ingest content.
Contents
- appIntegrationArn
-
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce
, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow
, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk
, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint
, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3
, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.Important
The bucket policy of the corresponding S3 bucket must allow the AWS principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$
Required: Yes
-
- objectFields
-
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce
, you must include at least Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow
, you must include at least number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk
, you must include at least id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: