awscc.kendra_datasource¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - kendra:DescribeDataSource, kendra:DeleteDataSource
update¶
Parent base class for filters and actions.
definitions:
AccessControlListConfiguration:
additionalProperties: false
properties:
KeyPath:
maxLength: 1024
minLength: 1
type: string
type: object
AclConfiguration:
additionalProperties: false
properties:
AllowedGroupsColumnName:
maxLength: 100
minLength: 1
type: string
required:
- AllowedGroupsColumnName
type: object
Arn:
maxLength: 1000
type: string
ChangeDetectingColumns:
items:
maxLength: 100
minLength: 1
type: string
maxItems: 5
minItems: 1
type: array
ColumnConfiguration:
additionalProperties: false
properties:
ChangeDetectingColumns:
items:
maxLength: 100
minLength: 1
type: string
maxItems: 5
minItems: 1
type: array
DocumentDataColumnName:
maxLength: 100
minLength: 1
type: string
DocumentIdColumnName:
maxLength: 100
minLength: 1
type: string
DocumentTitleColumnName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentIdColumnName
- DocumentDataColumnName
- ChangeDetectingColumns
type: object
ColumnName:
maxLength: 100
minLength: 1
type: string
ConfluenceAttachmentConfiguration:
additionalProperties: false
properties:
AttachmentFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 11
minItems: 1
type: array
CrawlAttachments:
type: boolean
type: object
ConfluenceAttachmentFieldMappingsList:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 11
minItems: 1
type: array
ConfluenceAttachmentFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
ConfluenceAttachmentToIndexFieldMapping:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
ConfluenceBlogConfiguration:
additionalProperties: false
properties:
BlogFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 9
minItems: 1
type: array
type: object
ConfluenceBlogFieldMappingsList:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 9
minItems: 1
type: array
ConfluenceBlogFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
ConfluenceBlogToIndexFieldMapping:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
ConfluenceConfiguration:
additionalProperties: false
properties:
AttachmentConfiguration:
additionalProperties: false
properties:
AttachmentFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 11
minItems: 1
type: array
CrawlAttachments:
type: boolean
type: object
BlogConfiguration:
additionalProperties: false
properties:
BlogFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 9
minItems: 1
type: array
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
PageConfiguration:
additionalProperties: false
properties:
PageFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 12
minItems: 1
type: array
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
SpaceConfiguration:
additionalProperties: false
properties:
CrawlArchivedSpaces:
type: boolean
CrawlPersonalSpaces:
type: boolean
ExcludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
IncludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
SpaceFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 4
minItems: 1
type: array
type: object
Version:
enum:
- CLOUD
- SERVER
type: string
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ServerUrl
- SecretArn
- Version
type: object
ConfluencePageConfiguration:
additionalProperties: false
properties:
PageFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 12
minItems: 1
type: array
type: object
ConfluencePageFieldMappingsList:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 12
minItems: 1
type: array
ConfluencePageFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
ConfluencePageToIndexFieldMapping:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
ConfluenceSpaceConfiguration:
additionalProperties: false
properties:
CrawlArchivedSpaces:
type: boolean
CrawlPersonalSpaces:
type: boolean
ExcludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
IncludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
SpaceFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 4
minItems: 1
type: array
type: object
ConfluenceSpaceFieldMappingsList:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 4
minItems: 1
type: array
ConfluenceSpaceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
ConfluenceSpaceIdentifier:
maxLength: 255
minLength: 1
type: string
ConfluenceSpaceList:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
ConfluenceSpaceToIndexFieldMapping:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
ConfluenceVersion:
enum:
- CLOUD
- SERVER
type: string
ConnectionConfiguration:
additionalProperties: false
properties:
DatabaseHost:
maxLength: 253
minLength: 1
type: string
DatabaseName:
maxLength: 100
minLength: 1
type: string
DatabasePort:
maximum: 65535
minimum: 1
type: integer
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TableName:
maxLength: 100
minLength: 1
type: string
required:
- DatabaseHost
- DatabasePort
- DatabaseName
- TableName
- SecretArn
type: object
DataSourceConfiguration:
additionalProperties: false
oneOf:
- required:
- S3Configuration
- required:
- SharePointConfiguration
- required:
- SalesforceConfiguration
- required:
- OneDriveConfiguration
- required:
- ServiceNowConfiguration
- required:
- DatabaseConfiguration
- required:
- ConfluenceConfiguration
- required:
- GoogleDriveConfiguration
- required:
- WebCrawlerConfiguration
- required:
- WorkDocsConfiguration
properties:
ConfluenceConfiguration:
additionalProperties: false
properties:
AttachmentConfiguration:
additionalProperties: false
properties:
AttachmentFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 11
minItems: 1
type: array
CrawlAttachments:
type: boolean
type: object
BlogConfiguration:
additionalProperties: false
properties:
BlogFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 9
minItems: 1
type: array
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
PageConfiguration:
additionalProperties: false
properties:
PageFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 12
minItems: 1
type: array
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
SpaceConfiguration:
additionalProperties: false
properties:
CrawlArchivedSpaces:
type: boolean
CrawlPersonalSpaces:
type: boolean
ExcludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
IncludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
SpaceFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 4
minItems: 1
type: array
type: object
Version:
enum:
- CLOUD
- SERVER
type: string
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ServerUrl
- SecretArn
- Version
type: object
DatabaseConfiguration:
additionalProperties: false
properties:
AclConfiguration:
additionalProperties: false
properties:
AllowedGroupsColumnName:
maxLength: 100
minLength: 1
type: string
required:
- AllowedGroupsColumnName
type: object
ColumnConfiguration:
additionalProperties: false
properties:
ChangeDetectingColumns:
items:
maxLength: 100
minLength: 1
type: string
maxItems: 5
minItems: 1
type: array
DocumentDataColumnName:
maxLength: 100
minLength: 1
type: string
DocumentIdColumnName:
maxLength: 100
minLength: 1
type: string
DocumentTitleColumnName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentIdColumnName
- DocumentDataColumnName
- ChangeDetectingColumns
type: object
ConnectionConfiguration:
additionalProperties: false
properties:
DatabaseHost:
maxLength: 253
minLength: 1
type: string
DatabaseName:
maxLength: 100
minLength: 1
type: string
DatabasePort:
maximum: 65535
minimum: 1
type: integer
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TableName:
maxLength: 100
minLength: 1
type: string
required:
- DatabaseHost
- DatabasePort
- DatabaseName
- TableName
- SecretArn
type: object
DatabaseEngineType:
enum:
- RDS_AURORA_MYSQL
- RDS_AURORA_POSTGRESQL
- RDS_MYSQL
- RDS_POSTGRESQL
type: string
SqlConfiguration:
additionalProperties: false
properties:
QueryIdentifiersEnclosingOption:
enum:
- DOUBLE_QUOTES
- NONE
type: string
type: object
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ConnectionConfiguration
- ColumnConfiguration
- DatabaseEngineType
type: object
GoogleDriveConfiguration:
additionalProperties: false
properties:
ExcludeMimeTypes:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 30
minItems: 0
type: array
ExcludeSharedDrives:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExcludeUserAccounts:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
required:
- SecretArn
type: object
OneDriveConfiguration:
additionalProperties: false
properties:
DisableLocalGroups:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OneDriveUsers:
additionalProperties: false
oneOf:
- required:
- OneDriveUserList
- required:
- OneDriveUserS3Path
properties:
OneDriveUserList:
items:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
maxItems: 100
minItems: 1
type: array
OneDriveUserS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TenantDomain:
maxLength: 256
minLength: 1
pattern: ^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$
type: string
required:
- TenantDomain
- SecretArn
- OneDriveUsers
type: object
S3Configuration:
additionalProperties: false
description: S3 data source configuration
properties:
AccessControlListConfiguration:
additionalProperties: false
properties:
KeyPath:
maxLength: 1024
minLength: 1
type: string
type: object
BucketName:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
DocumentsMetadataConfiguration:
additionalProperties: false
properties:
S3Prefix:
maxLength: 1024
minLength: 1
type: string
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPrefixes:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- BucketName
type: object
SalesforceConfiguration:
additionalProperties: false
properties:
ChatterFeedConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeFilterTypes:
items:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
maxItems: 2
minItems: 1
type: array
required:
- DocumentDataFieldName
type: object
CrawlAttachments:
type: boolean
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CustomKnowledgeArticleTypeConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 10
minItems: 1
type: array
IncludedStates:
items:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
maxItems: 3
minItems: 1
type: array
StandardKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
required:
- IncludedStates
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
StandardObjectAttachmentConfiguration:
additionalProperties: false
properties:
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
type: object
StandardObjectConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 17
minItems: 1
type: array
required:
- ServerUrl
- SecretArn
type: object
ServiceNowConfiguration:
additionalProperties: false
properties:
AuthenticationType:
enum:
- HTTP_BASIC
- OAUTH2
type: string
HostUrl:
maxLength: 2048
minLength: 1
pattern: ^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$
type: string
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
FilterQuery:
maxLength: 2048
minLength: 1
type: string
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServiceCatalogConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
ServiceNowBuildVersion:
enum:
- LONDON
- OTHERS
type: string
required:
- HostUrl
- SecretArn
- ServiceNowBuildVersion
type: object
SharePointConfiguration:
additionalProperties: false
description: SharePoint configuration
properties:
CrawlAttachments:
type: boolean
DisableLocalGroups:
type: boolean
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
SharePointVersion:
enum:
- SHAREPOINT_ONLINE
- SHAREPOINT_2013
- SHAREPOINT_2016
type: string
SslCertificateS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
Urls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
maxItems: 100
type: array
UseChangeLog:
type: boolean
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- Urls
- SecretArn
- SharePointVersion
type: object
WebCrawlerConfiguration:
additionalProperties: false
properties:
AuthenticationConfiguration:
additionalProperties: false
properties:
BasicAuthentication:
items:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
maxItems: 10
type: array
type: object
CrawlDepth:
maximum: 10
minimum: 1
type: integer
MaxContentSizePerPageInMegaBytes:
maximum: 50
minimum: 0
type: number
MaxLinksPerPage:
maximum: 1000
minimum: 1
type: integer
MaxUrlsPerMinuteCrawlRate:
maximum: 300
minimum: 1
type: integer
ProxyConfiguration:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
type: object
UrlExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
UrlInclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
Urls:
additionalProperties: false
properties:
SeedUrlConfiguration:
additionalProperties: false
properties:
SeedUrls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerMode:
enum:
- HOST_ONLY
- SUBDOMAINS
- EVERYTHING
type: string
required:
- SeedUrls
type: object
SiteMapsConfiguration:
additionalProperties: false
properties:
SiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
required:
- SiteMaps
type: object
type: object
required:
- Urls
type: object
WorkDocsConfiguration:
additionalProperties: false
properties:
CrawlComments:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OrganizationId:
maxLength: 12
minLength: 12
pattern: d-[0-9a-fA-F]{10}
type: string
UseChangeLog:
type: boolean
required:
- OrganizationId
type: object
type: object
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DataSourceInclusionsExclusionsStrings:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
DataSourceToIndexFieldMapping:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
DataSourceToIndexFieldMappingList:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
DataSourceVpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
DatabaseConfiguration:
additionalProperties: false
properties:
AclConfiguration:
additionalProperties: false
properties:
AllowedGroupsColumnName:
maxLength: 100
minLength: 1
type: string
required:
- AllowedGroupsColumnName
type: object
ColumnConfiguration:
additionalProperties: false
properties:
ChangeDetectingColumns:
items:
maxLength: 100
minLength: 1
type: string
maxItems: 5
minItems: 1
type: array
DocumentDataColumnName:
maxLength: 100
minLength: 1
type: string
DocumentIdColumnName:
maxLength: 100
minLength: 1
type: string
DocumentTitleColumnName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentIdColumnName
- DocumentDataColumnName
- ChangeDetectingColumns
type: object
ConnectionConfiguration:
additionalProperties: false
properties:
DatabaseHost:
maxLength: 253
minLength: 1
type: string
DatabaseName:
maxLength: 100
minLength: 1
type: string
DatabasePort:
maximum: 65535
minimum: 1
type: integer
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TableName:
maxLength: 100
minLength: 1
type: string
required:
- DatabaseHost
- DatabasePort
- DatabaseName
- TableName
- SecretArn
type: object
DatabaseEngineType:
enum:
- RDS_AURORA_MYSQL
- RDS_AURORA_POSTGRESQL
- RDS_MYSQL
- RDS_POSTGRESQL
type: string
SqlConfiguration:
additionalProperties: false
properties:
QueryIdentifiersEnclosingOption:
enum:
- DOUBLE_QUOTES
- NONE
type: string
type: object
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ConnectionConfiguration
- ColumnConfiguration
- DatabaseEngineType
type: object
DatabaseEngineType:
enum:
- RDS_AURORA_MYSQL
- RDS_AURORA_POSTGRESQL
- RDS_MYSQL
- RDS_POSTGRESQL
type: string
DatabaseHost:
maxLength: 253
minLength: 1
type: string
DatabaseName:
maxLength: 100
minLength: 1
type: string
DatabasePort:
maximum: 65535
minimum: 1
type: integer
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
Description:
description: Description of data source
maxLength: 1000
minLength: 1
type: string
DisableLocalGroups:
type: boolean
DocumentsMetadataConfiguration:
additionalProperties: false
properties:
S3Prefix:
maxLength: 1024
minLength: 1
type: string
type: object
ExcludeMimeTypesList:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 30
minItems: 0
type: array
ExcludeSharedDrivesList:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExcludeUserAccountsList:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
GoogleDriveConfiguration:
additionalProperties: false
properties:
ExcludeMimeTypes:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 30
minItems: 0
type: array
ExcludeSharedDrives:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExcludeUserAccounts:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
required:
- SecretArn
type: object
Id:
description: ID of data source
maxLength: 100
minLength: 1
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
IndexId:
description: ID of Index
maxLength: 36
minLength: 36
type: string
MimeType:
maxLength: 256
minLength: 1
type: string
Name:
description: Name of data source
maxLength: 1000
minLength: 1
type: string
OneDriveConfiguration:
additionalProperties: false
properties:
DisableLocalGroups:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OneDriveUsers:
additionalProperties: false
oneOf:
- required:
- OneDriveUserList
- required:
- OneDriveUserS3Path
properties:
OneDriveUserList:
items:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
maxItems: 100
minItems: 1
type: array
OneDriveUserS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TenantDomain:
maxLength: 256
minLength: 1
pattern: ^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$
type: string
required:
- TenantDomain
- SecretArn
- OneDriveUsers
type: object
OneDriveUser:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
OneDriveUserList:
items:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
maxItems: 100
minItems: 1
type: array
OneDriveUsers:
additionalProperties: false
oneOf:
- required:
- OneDriveUserList
- required:
- OneDriveUserS3Path
properties:
OneDriveUserList:
items:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
maxItems: 100
minItems: 1
type: array
OneDriveUserS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
type: object
ProxyConfiguration:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
type: object
QueryIdentifiersEnclosingOption:
enum:
- DOUBLE_QUOTES
- NONE
type: string
RoleArn:
description: Role ARN
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
S3BucketName:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
S3DataSourceConfiguration:
additionalProperties: false
description: S3 data source configuration
properties:
AccessControlListConfiguration:
additionalProperties: false
properties:
KeyPath:
maxLength: 1024
minLength: 1
type: string
type: object
BucketName:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
DocumentsMetadataConfiguration:
additionalProperties: false
properties:
S3Prefix:
maxLength: 1024
minLength: 1
type: string
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPrefixes:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- BucketName
type: object
S3ObjectKey:
maxLength: 1024
minLength: 1
type: string
S3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
SalesforceChatterFeedConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeFilterTypes:
items:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
maxItems: 2
minItems: 1
type: array
required:
- DocumentDataFieldName
type: object
SalesforceChatterFeedIncludeFilterType:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
SalesforceChatterFeedIncludeFilterTypes:
items:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
maxItems: 2
minItems: 1
type: array
SalesforceConfiguration:
additionalProperties: false
properties:
ChatterFeedConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeFilterTypes:
items:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
maxItems: 2
minItems: 1
type: array
required:
- DocumentDataFieldName
type: object
CrawlAttachments:
type: boolean
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CustomKnowledgeArticleTypeConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 10
minItems: 1
type: array
IncludedStates:
items:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
maxItems: 3
minItems: 1
type: array
StandardKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
required:
- IncludedStates
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
StandardObjectAttachmentConfiguration:
additionalProperties: false
properties:
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
type: object
StandardObjectConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 17
minItems: 1
type: array
required:
- ServerUrl
- SecretArn
type: object
SalesforceCustomKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
SalesforceCustomKnowledgeArticleTypeConfigurationList:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 10
minItems: 1
type: array
SalesforceCustomKnowledgeArticleTypeName:
maxLength: 100
minLength: 1
type: string
SalesforceKnowledgeArticleConfiguration:
additionalProperties: false
properties:
CustomKnowledgeArticleTypeConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 10
minItems: 1
type: array
IncludedStates:
items:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
maxItems: 3
minItems: 1
type: array
StandardKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
required:
- IncludedStates
type: object
SalesforceKnowledgeArticleState:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
SalesforceKnowledgeArticleStateList:
items:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
maxItems: 3
minItems: 1
type: array
SalesforceStandardKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
SalesforceStandardObjectAttachmentConfiguration:
additionalProperties: false
properties:
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
type: object
SalesforceStandardObjectConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
required:
- Name
- DocumentDataFieldName
type: object
SalesforceStandardObjectConfigurationList:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 17
minItems: 1
type: array
SalesforceStandardObjectName:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
Schedule:
description: Schedule
maxLength: 1000
type: string
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServiceNowAuthenticationType:
enum:
- HTTP_BASIC
- OAUTH2
type: string
ServiceNowBuildVersionType:
enum:
- LONDON
- OTHERS
type: string
ServiceNowConfiguration:
additionalProperties: false
properties:
AuthenticationType:
enum:
- HTTP_BASIC
- OAUTH2
type: string
HostUrl:
maxLength: 2048
minLength: 1
pattern: ^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$
type: string
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
FilterQuery:
maxLength: 2048
minLength: 1
type: string
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServiceCatalogConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
ServiceNowBuildVersion:
enum:
- LONDON
- OTHERS
type: string
required:
- HostUrl
- SecretArn
- ServiceNowBuildVersion
type: object
ServiceNowHostUrl:
maxLength: 2048
minLength: 1
pattern: ^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$
type: string
ServiceNowKnowledgeArticleConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
FilterQuery:
maxLength: 2048
minLength: 1
type: string
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
ServiceNowKnowledgeArticleFilterQuery:
maxLength: 2048
minLength: 1
type: string
ServiceNowServiceCatalogConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
SharePointConfiguration:
additionalProperties: false
description: SharePoint configuration
properties:
CrawlAttachments:
type: boolean
DisableLocalGroups:
type: boolean
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
SharePointVersion:
enum:
- SHAREPOINT_ONLINE
- SHAREPOINT_2013
- SHAREPOINT_2016
type: string
SslCertificateS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
Urls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
maxItems: 100
type: array
UseChangeLog:
type: boolean
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- Urls
- SecretArn
- SharePointVersion
type: object
SharedDriveId:
maxLength: 256
minLength: 1
type: string
SqlConfiguration:
additionalProperties: false
properties:
QueryIdentifiersEnclosingOption:
enum:
- DOUBLE_QUOTES
- NONE
type: string
type: object
TableName:
maxLength: 100
minLength: 1
type: string
Tag:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
TagList:
description: List of tags
items:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
maxItems: 200
type: array
TenantDomain:
maxLength: 256
minLength: 1
pattern: ^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$
type: string
Type:
description: Data source type
enum:
- S3
- SHAREPOINT
- SALESFORCE
- ONEDRIVE
- SERVICENOW
- DATABASE
- CUSTOM
- CONFLUENCE
- GOOGLEDRIVE
- WEBCRAWLER
- WORKDOCS
type: string
Url:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
UserAccount:
maxLength: 256
minLength: 1
type: string
WebCrawlerAuthenticationConfiguration:
additionalProperties: false
properties:
BasicAuthentication:
items:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
maxItems: 10
type: array
type: object
WebCrawlerBasicAuthentication:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
WebCrawlerBasicAuthenticationList:
items:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
maxItems: 10
type: array
WebCrawlerConfiguration:
additionalProperties: false
properties:
AuthenticationConfiguration:
additionalProperties: false
properties:
BasicAuthentication:
items:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
maxItems: 10
type: array
type: object
CrawlDepth:
maximum: 10
minimum: 1
type: integer
MaxContentSizePerPageInMegaBytes:
maximum: 50
minimum: 0
type: number
MaxLinksPerPage:
maximum: 1000
minimum: 1
type: integer
MaxUrlsPerMinuteCrawlRate:
maximum: 300
minimum: 1
type: integer
ProxyConfiguration:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
type: object
UrlExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
UrlInclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
Urls:
additionalProperties: false
properties:
SeedUrlConfiguration:
additionalProperties: false
properties:
SeedUrls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerMode:
enum:
- HOST_ONLY
- SUBDOMAINS
- EVERYTHING
type: string
required:
- SeedUrls
type: object
SiteMapsConfiguration:
additionalProperties: false
properties:
SiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
required:
- SiteMaps
type: object
type: object
required:
- Urls
type: object
WebCrawlerSeedUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
WebCrawlerSeedUrlConfiguration:
additionalProperties: false
properties:
SeedUrls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerMode:
enum:
- HOST_ONLY
- SUBDOMAINS
- EVERYTHING
type: string
required:
- SeedUrls
type: object
WebCrawlerSeedUrlList:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerSiteMap:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
WebCrawlerSiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
WebCrawlerSiteMapsConfiguration:
additionalProperties: false
properties:
SiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
required:
- SiteMaps
type: object
WebCrawlerUrls:
additionalProperties: false
properties:
SeedUrlConfiguration:
additionalProperties: false
properties:
SeedUrls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerMode:
enum:
- HOST_ONLY
- SUBDOMAINS
- EVERYTHING
type: string
required:
- SeedUrls
type: object
SiteMapsConfiguration:
additionalProperties: false
properties:
SiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
required:
- SiteMaps
type: object
type: object
WorkDocsConfiguration:
additionalProperties: false
properties:
CrawlComments:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OrganizationId:
maxLength: 12
minLength: 12
pattern: d-[0-9a-fA-F]{10}
type: string
UseChangeLog:
type: boolean
required:
- OrganizationId
type: object
properties:
DataSourceConfiguration:
additionalProperties: false
oneOf:
- required:
- S3Configuration
- required:
- SharePointConfiguration
- required:
- SalesforceConfiguration
- required:
- OneDriveConfiguration
- required:
- ServiceNowConfiguration
- required:
- DatabaseConfiguration
- required:
- ConfluenceConfiguration
- required:
- GoogleDriveConfiguration
- required:
- WebCrawlerConfiguration
- required:
- WorkDocsConfiguration
properties:
ConfluenceConfiguration:
additionalProperties: false
properties:
AttachmentConfiguration:
additionalProperties: false
properties:
AttachmentFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_TYPE
- CREATED_DATE
- DISPLAY_URL
- FILE_SIZE
- ITEM_TYPE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 11
minItems: 1
type: array
CrawlAttachments:
type: boolean
type: object
BlogConfiguration:
additionalProperties: false
properties:
BlogFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- PUBLISH_DATE
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 9
minItems: 1
type: array
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
PageConfiguration:
additionalProperties: false
properties:
PageFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- AUTHOR
- CONTENT_STATUS
- CREATED_DATE
- DISPLAY_URL
- ITEM_TYPE
- LABELS
- MODIFIED_DATE
- PARENT_ID
- SPACE_KEY
- SPACE_NAME
- URL
- VERSION
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 12
minItems: 1
type: array
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
SpaceConfiguration:
additionalProperties: false
properties:
CrawlArchivedSpaces:
type: boolean
CrawlPersonalSpaces:
type: boolean
ExcludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
IncludeSpaces:
items:
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
SpaceFieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
enum:
- DISPLAY_URL
- ITEM_TYPE
- SPACE_KEY
- URL
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 4
minItems: 1
type: array
type: object
Version:
enum:
- CLOUD
- SERVER
type: string
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ServerUrl
- SecretArn
- Version
type: object
DatabaseConfiguration:
additionalProperties: false
properties:
AclConfiguration:
additionalProperties: false
properties:
AllowedGroupsColumnName:
maxLength: 100
minLength: 1
type: string
required:
- AllowedGroupsColumnName
type: object
ColumnConfiguration:
additionalProperties: false
properties:
ChangeDetectingColumns:
items:
maxLength: 100
minLength: 1
type: string
maxItems: 5
minItems: 1
type: array
DocumentDataColumnName:
maxLength: 100
minLength: 1
type: string
DocumentIdColumnName:
maxLength: 100
minLength: 1
type: string
DocumentTitleColumnName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentIdColumnName
- DocumentDataColumnName
- ChangeDetectingColumns
type: object
ConnectionConfiguration:
additionalProperties: false
properties:
DatabaseHost:
maxLength: 253
minLength: 1
type: string
DatabaseName:
maxLength: 100
minLength: 1
type: string
DatabasePort:
maximum: 65535
minimum: 1
type: integer
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TableName:
maxLength: 100
minLength: 1
type: string
required:
- DatabaseHost
- DatabasePort
- DatabaseName
- TableName
- SecretArn
type: object
DatabaseEngineType:
enum:
- RDS_AURORA_MYSQL
- RDS_AURORA_POSTGRESQL
- RDS_MYSQL
- RDS_POSTGRESQL
type: string
SqlConfiguration:
additionalProperties: false
properties:
QueryIdentifiersEnclosingOption:
enum:
- DOUBLE_QUOTES
- NONE
type: string
type: object
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- ConnectionConfiguration
- ColumnConfiguration
- DatabaseEngineType
type: object
GoogleDriveConfiguration:
additionalProperties: false
properties:
ExcludeMimeTypes:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 30
minItems: 0
type: array
ExcludeSharedDrives:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExcludeUserAccounts:
items:
maxLength: 256
minLength: 1
type: string
maxItems: 100
minItems: 0
type: array
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
required:
- SecretArn
type: object
OneDriveConfiguration:
additionalProperties: false
properties:
DisableLocalGroups:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OneDriveUsers:
additionalProperties: false
oneOf:
- required:
- OneDriveUserList
- required:
- OneDriveUserS3Path
properties:
OneDriveUserList:
items:
maxLength: 256
minLength: 1
pattern: ^(?!\s).+@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
type: string
maxItems: 100
minItems: 1
type: array
OneDriveUserS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
TenantDomain:
maxLength: 256
minLength: 1
pattern: ^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\.)+[a-z]{2,}$
type: string
required:
- TenantDomain
- SecretArn
- OneDriveUsers
type: object
S3Configuration:
additionalProperties: false
description: S3 data source configuration
properties:
AccessControlListConfiguration:
additionalProperties: false
properties:
KeyPath:
maxLength: 1024
minLength: 1
type: string
type: object
BucketName:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
DocumentsMetadataConfiguration:
additionalProperties: false
properties:
S3Prefix:
maxLength: 1024
minLength: 1
type: string
type: object
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
InclusionPrefixes:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- BucketName
type: object
SalesforceConfiguration:
additionalProperties: false
properties:
ChatterFeedConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeFilterTypes:
items:
enum:
- ACTIVE_USER
- STANDARD_USER
type: string
maxItems: 2
minItems: 1
type: array
required:
- DocumentDataFieldName
type: object
CrawlAttachments:
type: boolean
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CustomKnowledgeArticleTypeConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
maxLength: 100
minLength: 1
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 10
minItems: 1
type: array
IncludedStates:
items:
enum:
- DRAFT
- PUBLISHED
- ARCHIVED
type: string
maxItems: 3
minItems: 1
type: array
StandardKnowledgeArticleTypeConfiguration:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
required:
- IncludedStates
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServerUrl:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
StandardObjectAttachmentConfiguration:
additionalProperties: false
properties:
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
type: object
StandardObjectConfigurations:
items:
additionalProperties: false
properties:
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
Name:
enum:
- ACCOUNT
- CAMPAIGN
- CASE
- CONTACT
- CONTRACT
- DOCUMENT
- GROUP
- IDEA
- LEAD
- OPPORTUNITY
- PARTNER
- PRICEBOOK
- PRODUCT
- PROFILE
- SOLUTION
- TASK
- USER
type: string
required:
- Name
- DocumentDataFieldName
type: object
maxItems: 17
minItems: 1
type: array
required:
- ServerUrl
- SecretArn
type: object
ServiceNowConfiguration:
additionalProperties: false
properties:
AuthenticationType:
enum:
- HTTP_BASIC
- OAUTH2
type: string
HostUrl:
maxLength: 2048
minLength: 1
pattern: ^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(\.service-now\.com)$
type: string
KnowledgeArticleConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
FilterQuery:
maxLength: 2048
minLength: 1
type: string
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
ServiceCatalogConfiguration:
additionalProperties: false
properties:
CrawlAttachments:
type: boolean
DocumentDataFieldName:
maxLength: 100
minLength: 1
type: string
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExcludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
IncludeAttachmentFilePatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
required:
- DocumentDataFieldName
type: object
ServiceNowBuildVersion:
enum:
- LONDON
- OTHERS
type: string
required:
- HostUrl
- SecretArn
- ServiceNowBuildVersion
type: object
SharePointConfiguration:
additionalProperties: false
description: SharePoint configuration
properties:
CrawlAttachments:
type: boolean
DisableLocalGroups:
type: boolean
DocumentTitleFieldName:
maxLength: 100
minLength: 1
type: string
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
SecretArn:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
SharePointVersion:
enum:
- SHAREPOINT_ONLINE
- SHAREPOINT_2013
- SHAREPOINT_2016
type: string
SslCertificateS3Path:
additionalProperties: false
properties:
Bucket:
maxLength: 63
minLength: 3
pattern: '[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]'
type: string
Key:
maxLength: 1024
minLength: 1
type: string
required:
- Bucket
- Key
type: object
Urls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file)://([^\s]*)
type: string
maxItems: 100
type: array
UseChangeLog:
type: boolean
VpcConfiguration:
additionalProperties: false
properties:
SecurityGroupIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 10
type: array
SubnetIds:
items:
maxLength: 200
minLength: 1
pattern: '[\-0-9a-zA-Z]+'
type: string
maxItems: 6
type: array
required:
- SubnetIds
- SecurityGroupIds
type: object
required:
- Urls
- SecretArn
- SharePointVersion
type: object
WebCrawlerConfiguration:
additionalProperties: false
properties:
AuthenticationConfiguration:
additionalProperties: false
properties:
BasicAuthentication:
items:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
- Credentials
type: object
maxItems: 10
type: array
type: object
CrawlDepth:
maximum: 10
minimum: 1
type: integer
MaxContentSizePerPageInMegaBytes:
maximum: 50
minimum: 0
type: number
MaxLinksPerPage:
maximum: 1000
minimum: 1
type: integer
MaxUrlsPerMinuteCrawlRate:
maximum: 300
minimum: 1
type: integer
ProxyConfiguration:
additionalProperties: false
properties:
Credentials:
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Host:
maxLength: 253
minLength: 1
pattern: ([^\s]*)
type: string
Port:
maximum: 65535
minimum: 1
type: integer
required:
- Host
- Port
type: object
UrlExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
UrlInclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
Urls:
additionalProperties: false
properties:
SeedUrlConfiguration:
additionalProperties: false
properties:
SeedUrls:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?)://([^\s]*)
type: string
maxItems: 100
minItems: 0
type: array
WebCrawlerMode:
enum:
- HOST_ONLY
- SUBDOMAINS
- EVERYTHING
type: string
required:
- SeedUrls
type: object
SiteMapsConfiguration:
additionalProperties: false
properties:
SiteMaps:
items:
maxLength: 2048
minLength: 1
pattern: ^(https?):\/\/([^\s]*)
type: string
maxItems: 3
minItems: 0
type: array
required:
- SiteMaps
type: object
type: object
required:
- Urls
type: object
WorkDocsConfiguration:
additionalProperties: false
properties:
CrawlComments:
type: boolean
ExclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
FieldMappings:
items:
additionalProperties: false
properties:
DataSourceFieldName:
maxLength: 100
minLength: 1
type: string
DateFieldFormat:
maxLength: 40
minLength: 4
type: string
IndexFieldName:
maxLength: 30
minLength: 1
type: string
required:
- DataSourceFieldName
- IndexFieldName
type: object
maxItems: 100
type: array
InclusionPatterns:
items:
maxLength: 50
minLength: 1
type: string
maxItems: 100
type: array
OrganizationId:
maxLength: 12
minLength: 12
pattern: d-[0-9a-fA-F]{10}
type: string
UseChangeLog:
type: boolean
required:
- OrganizationId
type: object
type: object
Description:
description: Description of data source
maxLength: 1000
minLength: 1
type: string
IndexId:
description: ID of Index
maxLength: 36
minLength: 36
type: string
Name:
description: Name of data source
maxLength: 1000
minLength: 1
type: string
RoleArn:
description: Role ARN
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Schedule:
description: Schedule
maxLength: 1000
type: string
Tags:
description: List of tags
items:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
maxItems: 200
type: array
type:
enum:
- update
Permissions - kendra:DescribeDataSource, kendra:UpdateDataSource, kendra:ListTagsForResource, kendra:TagResource, kendra:UntagResource, iam:PassRole