Kendra Classes
AccessControlConfigurationSummary
Id
- Type:
- Required: Yes
AccessControlListConfiguration
KeyPath
- Type: typing.Optional[str]
AclConfiguration
AllowedGroupsColumnName
- Type:
- Required: Yes
AdditionalResultAttribute
Key
- Type:
- Required: Yes
ValueType
- Type: typing.Literal['TEXT_WITH_HIGHLIGHTS_VALUE']
- Required: Yes
Value
- Type:
- Required: Yes
AdditionalResultAttributeValue
TextWithHighlightsValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
AlfrescoConfiguration
SiteUrl
- Type:
- Required: Yes
SiteId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
SslCertificateS3Path
- Type:
- Required: Yes
CrawlSystemFolders
- Type: typing.Optional[bool]
CrawlComments
- Type: typing.Optional[bool]
EntityFilter
- Type: typing.Optional[typing.List[typing.Literal['blog', 'documentLibrary', 'wiki']]]
DocumentLibraryFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
BlogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WikiFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
AlfrescoConfigurationOutput
SiteUrl
- Type:
- Required: Yes
SiteId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
SslCertificateS3Path
- Type:
- Required: Yes
CrawlSystemFolders
- Type: typing.Optional[bool]
CrawlComments
- Type: typing.Optional[bool]
EntityFilter
- Type: typing.Optional[typing.List[typing.Literal['blog', 'documentLibrary', 'wiki']]]
DocumentLibraryFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
BlogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WikiFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
AssociateEntitiesToExperienceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
EntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.EntityConfiguration]
- Required: Yes
AssociateEntitiesToExperienceResponse
FailedEntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FailedEntity]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
AssociatePersonasToEntitiesRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Personas
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.EntityPersonaConfiguration]
- Required: Yes
AssociatePersonasToEntitiesResponse
FailedEntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FailedEntity]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
AttributeFilter
AndAllFilters
- Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
OrAllFilters
- Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
NotFilter
- Type: typing.Optional[typing.Dict[str, typing.Any]]
EqualsTo
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
ContainsAll
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
ContainsAny
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
GreaterThan
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
GreaterThanOrEquals
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
LessThan
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
LessThanOrEquals
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput, NoneType]
AttributeSuggestionsDescribeConfig
SuggestableConfigList
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SuggestableConfig]]
AttributeSuggestionsMode
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
AttributeSuggestionsGetConfig
SuggestionAttributes
- Type: typing.Optional[typing.List[str]]
AdditionalResponseAttributes
- Type: typing.Optional[typing.List[str]]
AttributeFilter
- Type:
UserContext
- Type:
AttributeSuggestionsUpdateConfig
SuggestableConfigList
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SuggestableConfig]]
AttributeSuggestionsMode
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
AuthenticationConfiguration
BasicAuthentication
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BasicAuthenticationConfiguration]]
AuthenticationConfigurationOutput
BasicAuthentication
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BasicAuthenticationConfiguration]]
BaseValidatorModel
Oops! This Pydantic model is currently empty. Stay tuned!
BasicAuthenticationConfiguration
Host
- Type:
- Required: Yes
Port
- Type:
- Required: Yes
Credentials
- Type:
- Required: Yes
BatchDeleteDocumentRequest
IndexId
- Type:
- Required: Yes
DocumentIdList
- Type: typing.List[str]
- Required: Yes
DataSourceSyncJobMetricTarget
- Type:
BatchDeleteDocumentResponse
FailedDocuments
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BatchDeleteDocumentResponseFailedDocument]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchDeleteDocumentResponseFailedDocument
Id
- Type: typing.Optional[str]
DataSourceId
- Type: typing.Optional[str]
ErrorCode
- Type: typing.Optional[typing.Literal['InternalError', 'InvalidRequest']]
ErrorMessage
- Type: typing.Optional[str]
BatchDeleteFeaturedResultsSetError
Id
- Type:
- Required: Yes
ErrorCode
- Type: typing.Literal['InternalError', 'InvalidRequest']
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
BatchDeleteFeaturedResultsSetRequest
IndexId
- Type:
- Required: Yes
FeaturedResultsSetIds
- Type: typing.List[str]
- Required: Yes
BatchDeleteFeaturedResultsSetResponse
Errors
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BatchDeleteFeaturedResultsSetError]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetDocumentStatusRequest
IndexId
- Type:
- Required: Yes
DocumentInfoList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentInfo]
- Required: Yes
BatchGetDocumentStatusResponse
Errors
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BatchGetDocumentStatusResponseError]
- Required: Yes
DocumentStatusList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Status]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetDocumentStatusResponseError
DocumentId
- Type: typing.Optional[str]
DataSourceId
- Type: typing.Optional[str]
ErrorCode
- Type: typing.Optional[typing.Literal['InternalError', 'InvalidRequest']]
ErrorMessage
- Type: typing.Optional[str]
BatchPutDocumentRequest
IndexId
- Type:
- Required: Yes
Documents
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Document]
- Required: Yes
RoleArn
- Type: typing.Optional[str]
CustomDocumentEnrichmentConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfigurationOutput, NoneType]
BatchPutDocumentResponse
FailedDocuments
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.BatchPutDocumentResponseFailedDocument]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchPutDocumentResponseFailedDocument
Id
- Type: typing.Optional[str]
DataSourceId
- Type: typing.Optional[str]
ErrorCode
- Type: typing.Optional[typing.Literal['InternalError', 'InvalidRequest']]
ErrorMessage
- Type: typing.Optional[str]
BoxConfiguration
EnterpriseId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
UseChangeLog
- Type: typing.Optional[bool]
CrawlComments
- Type: typing.Optional[bool]
CrawlTasks
- Type: typing.Optional[bool]
CrawlWebLinks
- Type: typing.Optional[bool]
FileFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
TaskFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
CommentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WebLinkFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
BoxConfigurationOutput
EnterpriseId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
UseChangeLog
- Type: typing.Optional[bool]
CrawlComments
- Type: typing.Optional[bool]
CrawlTasks
- Type: typing.Optional[bool]
CrawlWebLinks
- Type: typing.Optional[bool]
FileFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
TaskFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
CommentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WebLinkFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
CapacityUnitsConfiguration
StorageCapacityUnits
- Type:
- Required: Yes
QueryCapacityUnits
- Type:
- Required: Yes
ClearQuerySuggestionsRequest
IndexId
- Type:
- Required: Yes
ClickFeedback
ResultId
- Type:
- Required: Yes
ClickTime
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
CollapseConfiguration
DocumentAttributeKey
- Type:
- Required: Yes
SortingConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SortingConfiguration]]
MissingAttributeKeyStrategy
- Type: typing.Optional[typing.Literal['COLLAPSE', 'EXPAND', 'IGNORE']]
Expand
- Type: typing.Optional[bool]
ExpandConfiguration
- Type:
CollapsedResultDetail
DocumentAttribute
- Type:
- Required: Yes
ExpandedResults
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExpandedResultItem]]
ColumnConfiguration
DocumentIdColumnName
- Type:
- Required: Yes
DocumentDataColumnName
- Type:
- Required: Yes
ChangeDetectingColumns
- Type: typing.List[str]
- Required: Yes
DocumentTitleColumnName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ColumnConfigurationOutput
DocumentIdColumnName
- Type:
- Required: Yes
DocumentDataColumnName
- Type:
- Required: Yes
ChangeDetectingColumns
- Type: typing.List[str]
- Required: Yes
DocumentTitleColumnName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ConfluenceAttachmentConfiguration
CrawlAttachments
- Type: typing.Optional[bool]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceAttachmentToIndexFieldMapping]]
ConfluenceAttachmentConfigurationOutput
CrawlAttachments
- Type: typing.Optional[bool]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceAttachmentToIndexFieldMapping]]
ConfluenceAttachmentToIndexFieldMapping
DataSourceFieldName
- Type: typing.Optional[typing.Literal['AUTHOR', 'CONTENT_TYPE', 'CREATED_DATE', 'DISPLAY_URL', 'FILE_SIZE', 'ITEM_TYPE', 'PARENT_ID', 'SPACE_KEY', 'SPACE_NAME', 'URL', 'VERSION']]
DateFieldFormat
- Type: typing.Optional[str]
IndexFieldName
- Type: typing.Optional[str]
ConfluenceBlogConfiguration
BlogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceBlogToIndexFieldMapping]]
ConfluenceBlogConfigurationOutput
BlogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceBlogToIndexFieldMapping]]
ConfluenceBlogToIndexFieldMapping
DataSourceFieldName
- Type: typing.Optional[typing.Literal['AUTHOR', 'DISPLAY_URL', 'ITEM_TYPE', 'LABELS', 'PUBLISH_DATE', 'SPACE_KEY', 'SPACE_NAME', 'URL', 'VERSION']]
DateFieldFormat
- Type: typing.Optional[str]
IndexFieldName
- Type: typing.Optional[str]
ConfluenceConfiguration
ServerUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
Version
- Type: typing.Literal['CLOUD', 'SERVER']
- Required: Yes
SpaceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceSpaceConfiguration]
PageConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluencePageConfiguration]
BlogConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceBlogConfiguration]
AttachmentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceAttachmentConfiguration]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
ProxyConfiguration
- Type:
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'PAT']]
ConfluenceConfigurationOutput
ServerUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
Version
- Type: typing.Literal['CLOUD', 'SERVER']
- Required: Yes
SpaceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceSpaceConfigurationOutput]
PageConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluencePageConfigurationOutput]
BlogConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceBlogConfigurationOutput]
AttachmentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceAttachmentConfigurationOutput]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
ProxyConfiguration
- Type:
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'PAT']]
ConfluencePageConfiguration
PageFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluencePageToIndexFieldMapping]]
ConfluencePageConfigurationOutput
PageFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluencePageToIndexFieldMapping]]
ConfluencePageToIndexFieldMapping
DataSourceFieldName
- Type: typing.Optional[typing.Literal['AUTHOR', 'CONTENT_STATUS', 'CREATED_DATE', 'DISPLAY_URL', 'ITEM_TYPE', 'LABELS', 'MODIFIED_DATE', 'PARENT_ID', 'SPACE_KEY', 'SPACE_NAME', 'URL', 'VERSION']]
DateFieldFormat
- Type: typing.Optional[str]
IndexFieldName
- Type: typing.Optional[str]
ConfluenceSpaceConfiguration
CrawlPersonalSpaces
- Type: typing.Optional[bool]
CrawlArchivedSpaces
- Type: typing.Optional[bool]
IncludeSpaces
- Type: typing.Optional[typing.List[str]]
ExcludeSpaces
- Type: typing.Optional[typing.List[str]]
SpaceFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceSpaceToIndexFieldMapping]]
ConfluenceSpaceConfigurationOutput
CrawlPersonalSpaces
- Type: typing.Optional[bool]
CrawlArchivedSpaces
- Type: typing.Optional[bool]
IncludeSpaces
- Type: typing.Optional[typing.List[str]]
ExcludeSpaces
- Type: typing.Optional[typing.List[str]]
SpaceFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceSpaceToIndexFieldMapping]]
ConfluenceSpaceToIndexFieldMapping
DataSourceFieldName
- Type: typing.Optional[typing.Literal['DISPLAY_URL', 'ITEM_TYPE', 'SPACE_KEY', 'URL']]
DateFieldFormat
- Type: typing.Optional[str]
IndexFieldName
- Type: typing.Optional[str]
ConnectionConfiguration
DatabaseHost
- Type:
- Required: Yes
DatabasePort
- Type:
- Required: Yes
DatabaseName
- Type:
- Required: Yes
TableName
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
ContentSourceConfiguration
DataSourceIds
- Type: typing.Optional[typing.List[str]]
FaqIds
- Type: typing.Optional[typing.List[str]]
DirectPutContent
- Type: typing.Optional[bool]
ContentSourceConfigurationOutput
DataSourceIds
- Type: typing.Optional[typing.List[str]]
FaqIds
- Type: typing.Optional[typing.List[str]]
DirectPutContent
- Type: typing.Optional[bool]
Correction
BeginOffset
- Type: typing.Optional[int]
EndOffset
- Type: typing.Optional[int]
Term
- Type: typing.Optional[str]
CorrectedTerm
- Type: typing.Optional[str]
CreateAccessControlConfigurationRequest
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
AccessControlList
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]]
HierarchicalAccessControlList
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipal, aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipalOutput]]]
ClientToken
- Type: typing.Optional[str]
CreateAccessControlConfigurationResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateDataSourceRequest
Name
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Type
- Type: typing.Literal['ALFRESCO', 'BOX', 'CONFLUENCE', 'CUSTOM', 'DATABASE', 'FSX', 'GITHUB', 'GOOGLEDRIVE', 'JIRA', 'ONEDRIVE', 'QUIP', 'S3', 'SALESFORCE', 'SERVICENOW', 'SHAREPOINT', 'SLACK', 'TEMPLATE', 'WEBCRAWLER', 'WORKDOCS']
- Required: Yes
Configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceConfigurationOutput, NoneType]
VpcConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput, NoneType]
Description
- Type: typing.Optional[str]
Schedule
- Type: typing.Optional[str]
RoleArn
- Type: typing.Optional[str]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
ClientToken
- Type: typing.Optional[str]
LanguageCode
- Type: typing.Optional[str]
CustomDocumentEnrichmentConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfigurationOutput, NoneType]
CreateDataSourceResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateExperienceRequest
Name
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
RoleArn
- Type: typing.Optional[str]
Configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceConfigurationOutput, NoneType]
Description
- Type: typing.Optional[str]
ClientToken
- Type: typing.Optional[str]
CreateExperienceResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateFaqRequest
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
S3Path
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
FileFormat
- Type: typing.Optional[typing.Literal['CSV', 'CSV_WITH_HEADER', 'JSON']]
ClientToken
- Type: typing.Optional[str]
LanguageCode
- Type: typing.Optional[str]
CreateFaqResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateFeaturedResultsSetRequest
IndexId
- Type:
- Required: Yes
FeaturedResultsSetName
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
ClientToken
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
QueryTexts
- Type: typing.Optional[typing.List[str]]
FeaturedDocuments
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedDocument]]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
CreateFeaturedResultsSetResponse
FeaturedResultsSet
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateIndexRequest
Name
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
Edition
- Type: typing.Optional[typing.Literal['DEVELOPER_EDITION', 'ENTERPRISE_EDITION', 'GEN_AI_ENTERPRISE_EDITION']]
ServerSideEncryptionConfiguration
- Type:
Description
- Type: typing.Optional[str]
ClientToken
- Type: typing.Optional[str]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
UserTokenConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.UserTokenConfiguration]]
UserContextPolicy
- Type: typing.Optional[typing.Literal['ATTRIBUTE_FILTER', 'USER_TOKEN']]
UserGroupResolutionConfiguration
- Type:
CreateIndexResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateQuerySuggestionsBlockListRequest
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
SourceS3Path
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
ClientToken
- Type: typing.Optional[str]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
CreateQuerySuggestionsBlockListResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateThesaurusRequest
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
SourceS3Path
- Type:
- Required: Yes
Description
- Type: typing.Optional[str]
Tags
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]]
ClientToken
- Type: typing.Optional[str]
CreateThesaurusResponse
Id
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CustomDocumentEnrichmentConfiguration
InlineConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.InlineCustomDocumentEnrichmentConfiguration]]
PreExtractionHookConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.HookConfiguration]
PostExtractionHookConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.HookConfiguration]
RoleArn
- Type: typing.Optional[str]
CustomDocumentEnrichmentConfigurationOutput
InlineConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.InlineCustomDocumentEnrichmentConfigurationOutput]]
PreExtractionHookConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.HookConfigurationOutput]
PostExtractionHookConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.HookConfigurationOutput]
RoleArn
- Type: typing.Optional[str]
DataSourceConfiguration
S3Configuration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3DataSourceConfiguration]
SharePointConfiguration
- Type:
DatabaseConfiguration
- Type:
SalesforceConfiguration
- Type:
OneDriveConfiguration
- Type:
ServiceNowConfiguration
- Type:
ConfluenceConfiguration
- Type:
GoogleDriveConfiguration
- Type:
WebCrawlerConfiguration
- Type:
WorkDocsConfiguration
- Type:
FsxConfiguration
- Type:
SlackConfiguration
- Type:
BoxConfiguration
- Type:
QuipConfiguration
- Type:
JiraConfiguration
- Type:
GitHubConfiguration
- Type:
AlfrescoConfiguration
- Type:
TemplateConfiguration
- Type:
DataSourceConfigurationOutput
S3Configuration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3DataSourceConfigurationOutput]
SharePointConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SharePointConfigurationOutput]
DatabaseConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DatabaseConfigurationOutput]
SalesforceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceConfigurationOutput]
OneDriveConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.OneDriveConfigurationOutput]
ServiceNowConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ServiceNowConfigurationOutput]
ConfluenceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ConfluenceConfigurationOutput]
GoogleDriveConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.GoogleDriveConfigurationOutput]
WebCrawlerConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.WebCrawlerConfigurationOutput]
WorkDocsConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.WorkDocsConfigurationOutput]
FsxConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.FsxConfigurationOutput]
SlackConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SlackConfigurationOutput]
BoxConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.BoxConfigurationOutput]
QuipConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.QuipConfigurationOutput]
JiraConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.JiraConfigurationOutput]
GitHubConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.GitHubConfigurationOutput]
AlfrescoConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.AlfrescoConfigurationOutput]
TemplateConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TemplateConfigurationOutput]
DataSourceGroup
GroupId
- Type:
- Required: Yes
DataSourceId
- Type:
- Required: Yes
DataSourceSummary
Name
- Type: typing.Optional[str]
Id
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['ALFRESCO', 'BOX', 'CONFLUENCE', 'CUSTOM', 'DATABASE', 'FSX', 'GITHUB', 'GOOGLEDRIVE', 'JIRA', 'ONEDRIVE', 'QUIP', 'S3', 'SALESFORCE', 'SERVICENOW', 'SHAREPOINT', 'SLACK', 'TEMPLATE', 'WEBCRAWLER', 'WORKDOCS']]
CreatedAt
- Type: typing.Optional[datetime.datetime]
UpdatedAt
- Type: typing.Optional[datetime.datetime]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]
LanguageCode
- Type: typing.Optional[str]
DataSourceSyncJob
ExecutionId
- Type: typing.Optional[str]
StartTime
- Type: typing.Optional[datetime.datetime]
EndTime
- Type: typing.Optional[datetime.datetime]
Status
- Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'INCOMPLETE', 'STOPPING', 'SUCCEEDED', 'SYNCING', 'SYNCING_INDEXING']]
ErrorMessage
- Type: typing.Optional[str]
ErrorCode
- Type: typing.Optional[typing.Literal['InternalError', 'InvalidRequest']]
DataSourceErrorCode
- Type: typing.Optional[str]
Metrics
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceSyncJobMetrics]
DataSourceSyncJobMetricTarget
DataSourceId
- Type:
- Required: Yes
DataSourceSyncJobId
- Type: typing.Optional[str]
DataSourceSyncJobMetrics
DocumentsAdded
- Type: typing.Optional[str]
DocumentsModified
- Type: typing.Optional[str]
DocumentsDeleted
- Type: typing.Optional[str]
DocumentsFailed
- Type: typing.Optional[str]
DocumentsScanned
- Type: typing.Optional[str]
DataSourceToIndexFieldMapping
DataSourceFieldName
- Type:
- Required: Yes
IndexFieldName
- Type:
- Required: Yes
DateFieldFormat
- Type: typing.Optional[str]
DataSourceVpcConfiguration
SubnetIds
- Type: typing.List[str]
- Required: Yes
SecurityGroupIds
- Type: typing.List[str]
- Required: Yes
DataSourceVpcConfigurationOutput
SubnetIds
- Type: typing.List[str]
- Required: Yes
SecurityGroupIds
- Type: typing.List[str]
- Required: Yes
DatabaseConfiguration
DatabaseEngineType
- Type: typing.Literal['RDS_AURORA_MYSQL', 'RDS_AURORA_POSTGRESQL', 'RDS_MYSQL', 'RDS_POSTGRESQL']
- Required: Yes
ConnectionConfiguration
- Type:
- Required: Yes
ColumnConfiguration
- Type:
- Required: Yes
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
AclConfiguration
- Type:
SqlConfiguration
- Type:
DatabaseConfigurationOutput
DatabaseEngineType
- Type: typing.Literal['RDS_AURORA_MYSQL', 'RDS_AURORA_POSTGRESQL', 'RDS_MYSQL', 'RDS_POSTGRESQL']
- Required: Yes
ConnectionConfiguration
- Type:
- Required: Yes
ColumnConfiguration
- Type:
- Required: Yes
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
AclConfiguration
- Type:
SqlConfiguration
- Type:
DeleteAccessControlConfigurationRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
DeleteDataSourceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DeleteExperienceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DeleteFaqRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DeleteIndexRequest
Id
- Type:
- Required: Yes
DeletePrincipalMappingRequest
IndexId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
OrderingId
- Type: typing.Optional[int]
DeleteQuerySuggestionsBlockListRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
DeleteThesaurusRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DescribeAccessControlConfigurationRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
DescribeAccessControlConfigurationResponse
Name
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
AccessControlList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]
- Required: Yes
HierarchicalAccessControlList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipalOutput]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeDataSourceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DescribeDataSourceResponse
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['ALFRESCO', 'BOX', 'CONFLUENCE', 'CUSTOM', 'DATABASE', 'FSX', 'GITHUB', 'GOOGLEDRIVE', 'JIRA', 'ONEDRIVE', 'QUIP', 'S3', 'SALESFORCE', 'SERVICENOW', 'SHAREPOINT', 'SLACK', 'TEMPLATE', 'WEBCRAWLER', 'WORKDOCS']
- Required: Yes
Configuration
- Type:
- Required: Yes
VpcConfiguration
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
Schedule
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
LanguageCode
- Type:
- Required: Yes
CustomDocumentEnrichmentConfiguration
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeExperienceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DescribeExperienceResponse
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Endpoints
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceEndpoint]
- Required: Yes
Configuration
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED']
- Required: Yes
RoleArn
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeFaqRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DescribeFaqResponse
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
S3Path
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
RoleArn
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
FileFormat
- Type: typing.Literal['CSV', 'CSV_WITH_HEADER', 'JSON']
- Required: Yes
LanguageCode
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeFeaturedResultsSetRequest
IndexId
- Type:
- Required: Yes
FeaturedResultsSetId
- Type:
- Required: Yes
DescribeFeaturedResultsSetResponse
FeaturedResultsSetId
- Type:
- Required: Yes
FeaturedResultsSetName
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'INACTIVE']
- Required: Yes
QueryTexts
- Type: typing.List[str]
- Required: Yes
FeaturedDocumentsWithMetadata
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedDocumentWithMetadata]
- Required: Yes
FeaturedDocumentsMissing
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedDocumentMissing]
- Required: Yes
LastUpdatedTimestamp
- Type:
- Required: Yes
CreationTimestamp
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeIndexRequest
Id
- Type:
- Required: Yes
DescribeIndexResponse
Name
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
Edition
- Type: typing.Literal['DEVELOPER_EDITION', 'ENTERPRISE_EDITION', 'GEN_AI_ENTERPRISE_EDITION']
- Required: Yes
RoleArn
- Type:
- Required: Yes
ServerSideEncryptionConfiguration
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'SYSTEM_UPDATING', 'UPDATING']
- Required: Yes
Description
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
DocumentMetadataConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentMetadataConfigurationOutput]
- Required: Yes
IndexStatistics
- Type:
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
CapacityUnits
- Type:
- Required: Yes
UserTokenConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.UserTokenConfiguration]
- Required: Yes
UserContextPolicy
- Type: typing.Literal['ATTRIBUTE_FILTER', 'USER_TOKEN']
- Required: Yes
UserGroupResolutionConfiguration
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribePrincipalMappingRequest
IndexId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
DescribePrincipalMappingResponse
IndexId
- Type:
- Required: Yes
DataSourceId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
GroupOrderingIdSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.GroupOrderingIdSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeQuerySuggestionsBlockListRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
DescribeQuerySuggestionsBlockListResponse
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'ACTIVE_BUT_UPDATE_FAILED', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
SourceS3Path
- Type:
- Required: Yes
ItemCount
- Type:
- Required: Yes
FileSizeBytes
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeQuerySuggestionsConfigRequest
IndexId
- Type:
- Required: Yes
DescribeQuerySuggestionsConfigResponse
Mode
- Type: typing.Literal['ENABLED', 'LEARN_ONLY']
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'UPDATING']
- Required: Yes
QueryLogLookBackWindowInDays
- Type:
- Required: Yes
IncludeQueriesWithoutUserInformation
- Type:
- Required: Yes
MinimumNumberOfQueryingUsers
- Type:
- Required: Yes
MinimumQueryCount
- Type:
- Required: Yes
LastSuggestionsBuildTime
- Type:
- Required: Yes
LastClearTime
- Type:
- Required: Yes
TotalSuggestionsCount
- Type:
- Required: Yes
AttributeSuggestionsConfig
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeThesaurusRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
DescribeThesaurusResponse
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type:
- Required: Yes
Description
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'ACTIVE_BUT_UPDATE_FAILED', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
ErrorMessage
- Type:
- Required: Yes
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
RoleArn
- Type:
- Required: Yes
SourceS3Path
- Type:
- Required: Yes
FileSizeBytes
- Type:
- Required: Yes
TermCount
- Type:
- Required: Yes
SynonymRuleCount
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DisassociateEntitiesFromExperienceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
EntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.EntityConfiguration]
- Required: Yes
DisassociateEntitiesFromExperienceResponse
FailedEntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FailedEntity]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DisassociatePersonasFromEntitiesRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
EntityIds
- Type: typing.List[str]
- Required: Yes
DisassociatePersonasFromEntitiesResponse
FailedEntityList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FailedEntity]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
Document
Id
- Type:
- Required: Yes
Title
- Type: typing.Optional[str]
Blob
- Type:
S3Path
- Type:
Attributes
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]]
AccessControlList
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]]
HierarchicalAccessControlList
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipal, aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipalOutput]]]
ContentType
- Type: typing.Optional[typing.Literal['CSV', 'HTML', 'JSON', 'MD', 'MS_EXCEL', 'MS_WORD', 'PDF', 'PLAIN_TEXT', 'PPT', 'RTF', 'XML', 'XSLT']]
AccessControlConfigurationId
- Type: typing.Optional[str]
DocumentAttribute
Key
- Type:
- Required: Yes
Value
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValue, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValueOutput]
- Required: Yes
DocumentAttributeCondition
ConditionDocumentAttributeKey
- Type:
- Required: Yes
Operator
- Type: typing.Literal['BeginsWith', 'Contains', 'Equals', 'Exists', 'GreaterThan', 'GreaterThanOrEquals', 'LessThan', 'LessThanOrEquals', 'NotContains', 'NotEquals', 'NotExists']
- Required: Yes
ConditionOnValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValue]
DocumentAttributeConditionOutput
ConditionDocumentAttributeKey
- Type:
- Required: Yes
Operator
- Type: typing.Literal['BeginsWith', 'Contains', 'Equals', 'Exists', 'GreaterThan', 'GreaterThanOrEquals', 'LessThan', 'LessThanOrEquals', 'NotContains', 'NotEquals', 'NotExists']
- Required: Yes
ConditionOnValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValueOutput]
DocumentAttributeOutput
Key
- Type:
- Required: Yes
Value
- Type:
- Required: Yes
DocumentAttributeTarget
TargetDocumentAttributeKey
- Type: typing.Optional[str]
TargetDocumentAttributeValueDeletion
- Type: typing.Optional[bool]
TargetDocumentAttributeValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValue]
DocumentAttributeTargetOutput
TargetDocumentAttributeKey
- Type: typing.Optional[str]
TargetDocumentAttributeValueDeletion
- Type: typing.Optional[bool]
TargetDocumentAttributeValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValueOutput]
DocumentAttributeValue
StringValue
- Type: typing.Optional[str]
StringListValue
- Type: typing.Optional[typing.List[str]]
LongValue
- Type: typing.Optional[int]
DateValue
- Type: typing.Union[datetime.datetime, str, NoneType]
DocumentAttributeValueCountPair
DocumentAttributeValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValueOutput]
Count
- Type: typing.Optional[int]
FacetResults
- Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
DocumentAttributeValueOutput
StringValue
- Type: typing.Optional[str]
StringListValue
- Type: typing.Optional[typing.List[str]]
LongValue
- Type: typing.Optional[int]
DateValue
- Type: typing.Optional[datetime.datetime]
DocumentInfo
DocumentId
- Type:
- Required: Yes
Attributes
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttribute, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]]
DocumentMetadataConfiguration
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['DATE_VALUE', 'LONG_VALUE', 'STRING_LIST_VALUE', 'STRING_VALUE']
- Required: Yes
Relevance
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.Relevance, aws_resource_validator.pydantic_models.kendra.kendra_classes.RelevanceOutput, NoneType]
Search
- Type:
DocumentMetadataConfigurationOutput
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['DATE_VALUE', 'LONG_VALUE', 'STRING_LIST_VALUE', 'STRING_VALUE']
- Required: Yes
Relevance
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.RelevanceOutput]
Search
- Type:
DocumentRelevanceConfiguration
Name
- Type:
- Required: Yes
Relevance
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.Relevance, aws_resource_validator.pydantic_models.kendra.kendra_classes.RelevanceOutput]
- Required: Yes
DocumentsMetadataConfiguration
S3Prefix
- Type: typing.Optional[str]
EmptyResponseMetadata
ResponseMetadata
- Type:
- Required: Yes
EntityConfiguration
EntityId
- Type:
- Required: Yes
EntityType
- Type: typing.Literal['GROUP', 'USER']
- Required: Yes
EntityDisplayData
UserName
- Type: typing.Optional[str]
GroupName
- Type: typing.Optional[str]
IdentifiedUserName
- Type: typing.Optional[str]
FirstName
- Type: typing.Optional[str]
LastName
- Type: typing.Optional[str]
EntityPersonaConfiguration
EntityId
- Type:
- Required: Yes
Persona
- Type: typing.Literal['OWNER', 'VIEWER']
- Required: Yes
ExpandConfiguration
MaxResultItemsToExpand
- Type: typing.Optional[int]
MaxExpandedResultsPerItem
- Type: typing.Optional[int]
ExpandedResultItem
Id
- Type: typing.Optional[str]
DocumentId
- Type: typing.Optional[str]
DocumentTitle
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentExcerpt
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentURI
- Type: typing.Optional[str]
DocumentAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]
ExperienceConfiguration
ContentSourceConfiguration
- Type:
UserIdentityConfiguration
- Type:
ExperienceConfigurationOutput
ContentSourceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ContentSourceConfigurationOutput]
UserIdentityConfiguration
- Type:
ExperienceEndpoint
EndpointType
- Type: typing.Optional[typing.Literal['HOME']]
Endpoint
- Type: typing.Optional[str]
ExperienceEntitiesSummary
EntityId
- Type: typing.Optional[str]
EntityType
- Type: typing.Optional[typing.Literal['GROUP', 'USER']]
DisplayData
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.EntityDisplayData]
ExperiencesSummary
Name
- Type: typing.Optional[str]
Id
- Type: typing.Optional[str]
CreatedAt
- Type: typing.Optional[datetime.datetime]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED']]
Endpoints
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceEndpoint]]
Facet
DocumentAttributeKey
- Type: typing.Optional[str]
Facets
- Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
MaxResults
- Type: typing.Optional[int]
FacetResult
DocumentAttributeKey
- Type: typing.Optional[str]
DocumentAttributeValueType
- Type: typing.Optional[typing.Literal['DATE_VALUE', 'LONG_VALUE', 'STRING_LIST_VALUE', 'STRING_VALUE']]
DocumentAttributeValueCountPairs
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeValueCountPair]]
FailedEntity
EntityId
- Type: typing.Optional[str]
ErrorMessage
- Type: typing.Optional[str]
FaqStatistics
IndexedQuestionAnswersCount
- Type:
- Required: Yes
FaqSummary
Id
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]
CreatedAt
- Type: typing.Optional[datetime.datetime]
UpdatedAt
- Type: typing.Optional[datetime.datetime]
FileFormat
- Type: typing.Optional[typing.Literal['CSV', 'CSV_WITH_HEADER', 'JSON']]
LanguageCode
- Type: typing.Optional[str]
FeaturedDocument
Id
- Type: typing.Optional[str]
FeaturedDocumentMissing
Id
- Type: typing.Optional[str]
FeaturedDocumentWithMetadata
Id
- Type: typing.Optional[str]
Title
- Type: typing.Optional[str]
URI
- Type: typing.Optional[str]
FeaturedResultsItem
Id
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['ANSWER', 'DOCUMENT', 'QUESTION_ANSWER']]
AdditionalAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.AdditionalResultAttribute]]
DocumentId
- Type: typing.Optional[str]
DocumentTitle
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentExcerpt
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentURI
- Type: typing.Optional[str]
DocumentAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]
FeedbackToken
- Type: typing.Optional[str]
FeaturedResultsSet
FeaturedResultsSetId
- Type: typing.Optional[str]
FeaturedResultsSetName
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
QueryTexts
- Type: typing.Optional[typing.List[str]]
FeaturedDocuments
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedDocument]]
LastUpdatedTimestamp
- Type: typing.Optional[int]
CreationTimestamp
- Type: typing.Optional[int]
FeaturedResultsSetSummary
FeaturedResultsSetId
- Type: typing.Optional[str]
FeaturedResultsSetName
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
LastUpdatedTimestamp
- Type: typing.Optional[int]
CreationTimestamp
- Type: typing.Optional[int]
FsxConfiguration
FileSystemId
- Type:
- Required: Yes
FileSystemType
- Type: typing.Literal['WINDOWS']
- Required: Yes
VpcConfiguration
- Type:
- Required: Yes
SecretArn
- Type: typing.Optional[str]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
FsxConfigurationOutput
FileSystemId
- Type:
- Required: Yes
FileSystemType
- Type: typing.Literal['WINDOWS']
- Required: Yes
VpcConfiguration
- Type:
- Required: Yes
SecretArn
- Type: typing.Optional[str]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GetQuerySuggestionsRequest
IndexId
- Type:
- Required: Yes
QueryText
- Type:
- Required: Yes
MaxSuggestionsCount
- Type: typing.Optional[int]
SuggestionTypes
- Type: typing.Optional[typing.List[typing.Literal['DOCUMENT_ATTRIBUTES', 'QUERY']]]
AttributeSuggestionsConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.AttributeSuggestionsGetConfig]
GetQuerySuggestionsResponse
QuerySuggestionsId
- Type:
- Required: Yes
Suggestions
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Suggestion]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetSnapshotsRequest
IndexId
- Type:
- Required: Yes
Interval
- Type: typing.Literal['ONE_MONTH_AGO', 'ONE_WEEK_AGO', 'THIS_MONTH', 'THIS_WEEK', 'TWO_MONTHS_AGO', 'TWO_WEEKS_AGO']
- Required: Yes
MetricType
- Type: typing.Literal['AGG_QUERY_DOC_METRICS', 'DOCS_BY_CLICK_COUNT', 'QUERIES_BY_COUNT', 'QUERIES_BY_ZERO_CLICK_RATE', 'QUERIES_BY_ZERO_RESULT_RATE', 'TREND_QUERY_DOC_METRICS']
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
GetSnapshotsResponse
SnapShotTimeFilter
- Type:
- Required: Yes
SnapshotsDataHeader
- Type: typing.List[str]
- Required: Yes
SnapshotsData
- Type: typing.List[typing.List[str]]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
GitHubConfiguration
SecretArn
- Type:
- Required: Yes
SaaSConfiguration
- Type:
OnPremiseConfiguration
- Type:
Type
- Type: typing.Optional[typing.Literal['ON_PREMISE', 'SAAS']]
UseChangeLog
- Type: typing.Optional[bool]
GitHubDocumentCrawlProperties
- Type:
RepositoryFilter
- Type: typing.Optional[typing.List[str]]
InclusionFolderNamePatterns
- Type: typing.Optional[typing.List[str]]
InclusionFileTypePatterns
- Type: typing.Optional[typing.List[str]]
InclusionFileNamePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFolderNamePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFileTypePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFileNamePatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
GitHubRepositoryConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubCommitConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueDocumentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueCommentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueAttachmentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestCommentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestDocumentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubConfigurationOutput
SecretArn
- Type:
- Required: Yes
SaaSConfiguration
- Type:
OnPremiseConfiguration
- Type:
Type
- Type: typing.Optional[typing.Literal['ON_PREMISE', 'SAAS']]
UseChangeLog
- Type: typing.Optional[bool]
GitHubDocumentCrawlProperties
- Type:
RepositoryFilter
- Type: typing.Optional[typing.List[str]]
InclusionFolderNamePatterns
- Type: typing.Optional[typing.List[str]]
InclusionFileTypePatterns
- Type: typing.Optional[typing.List[str]]
InclusionFileNamePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFolderNamePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFileTypePatterns
- Type: typing.Optional[typing.List[str]]
ExclusionFileNamePatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
GitHubRepositoryConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubCommitConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueDocumentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueCommentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubIssueAttachmentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestCommentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestDocumentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
GitHubDocumentCrawlProperties
CrawlRepositoryDocuments
- Type: typing.Optional[bool]
CrawlIssue
- Type: typing.Optional[bool]
CrawlIssueComment
- Type: typing.Optional[bool]
CrawlIssueCommentAttachment
- Type: typing.Optional[bool]
CrawlPullRequest
- Type: typing.Optional[bool]
CrawlPullRequestComment
- Type: typing.Optional[bool]
CrawlPullRequestCommentAttachment
- Type: typing.Optional[bool]
GoogleDriveConfiguration
SecretArn
- Type:
- Required: Yes
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ExcludeMimeTypes
- Type: typing.Optional[typing.List[str]]
ExcludeUserAccounts
- Type: typing.Optional[typing.List[str]]
ExcludeSharedDrives
- Type: typing.Optional[typing.List[str]]
GoogleDriveConfigurationOutput
SecretArn
- Type:
- Required: Yes
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ExcludeMimeTypes
- Type: typing.Optional[typing.List[str]]
ExcludeUserAccounts
- Type: typing.Optional[typing.List[str]]
ExcludeSharedDrives
- Type: typing.Optional[typing.List[str]]
GroupMembers
MemberGroups
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.MemberGroup]]
MemberUsers
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.MemberUser]]
S3PathforGroupMembers
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
GroupOrderingIdSummary
Status
- Type: typing.Optional[typing.Literal['DELETED', 'DELETING', 'FAILED', 'PROCESSING', 'SUCCEEDED']]
LastUpdatedAt
- Type: typing.Optional[datetime.datetime]
ReceivedAt
- Type: typing.Optional[datetime.datetime]
OrderingId
- Type: typing.Optional[int]
FailureReason
- Type: typing.Optional[str]
GroupSummary
GroupId
- Type: typing.Optional[str]
OrderingId
- Type: typing.Optional[int]
HierarchicalPrincipal
PrincipalList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]
- Required: Yes
HierarchicalPrincipalOutput
PrincipalList
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]
- Required: Yes
Highlight
BeginOffset
- Type:
- Required: Yes
EndOffset
- Type:
- Required: Yes
TopAnswer
- Type: typing.Optional[bool]
Type
- Type: typing.Optional[typing.Literal['STANDARD', 'THESAURUS_SYNONYM']]
HookConfiguration
LambdaArn
- Type:
- Required: Yes
S3Bucket
- Type:
- Required: Yes
InvocationCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeCondition]
HookConfigurationOutput
LambdaArn
- Type:
- Required: Yes
S3Bucket
- Type:
- Required: Yes
InvocationCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeConditionOutput]
IndexConfigurationSummary
CreatedAt
- Type:
- Required: Yes
UpdatedAt
- Type:
- Required: Yes
Status
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'SYSTEM_UPDATING', 'UPDATING']
- Required: Yes
Name
- Type: typing.Optional[str]
Id
- Type: typing.Optional[str]
Edition
- Type: typing.Optional[typing.Literal['DEVELOPER_EDITION', 'ENTERPRISE_EDITION', 'GEN_AI_ENTERPRISE_EDITION']]
IndexStatistics
FaqStatistics
- Type:
- Required: Yes
TextDocumentStatistics
- Type:
- Required: Yes
InlineCustomDocumentEnrichmentConfiguration
Condition
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeCondition]
Target
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeTarget]
DocumentContentDeletion
- Type: typing.Optional[bool]
InlineCustomDocumentEnrichmentConfigurationOutput
Condition
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeConditionOutput]
Target
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeTargetOutput]
DocumentContentDeletion
- Type: typing.Optional[bool]
JiraConfiguration
JiraAccountUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
UseChangeLog
- Type: typing.Optional[bool]
Project
- Type: typing.Optional[typing.List[str]]
IssueType
- Type: typing.Optional[typing.List[str]]
Status
- Type: typing.Optional[typing.List[str]]
IssueSubEntityFilter
- Type: typing.Optional[typing.List[typing.Literal['ATTACHMENTS', 'COMMENTS', 'WORKLOGS']]]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
CommentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
IssueFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ProjectFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WorkLogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
JiraConfigurationOutput
JiraAccountUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
UseChangeLog
- Type: typing.Optional[bool]
Project
- Type: typing.Optional[typing.List[str]]
IssueType
- Type: typing.Optional[typing.List[str]]
Status
- Type: typing.Optional[typing.List[str]]
IssueSubEntityFilter
- Type: typing.Optional[typing.List[typing.Literal['ATTACHMENTS', 'COMMENTS', 'WORKLOGS']]]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
CommentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
IssueFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ProjectFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WorkLogFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
JsonTokenTypeConfiguration
UserNameAttributeField
- Type:
- Required: Yes
GroupAttributeField
- Type:
- Required: Yes
JwtTokenTypeConfiguration
KeyLocation
- Type: typing.Literal['SECRET_MANAGER', 'URL']
- Required: Yes
URL
- Type: typing.Optional[str]
SecretManagerArn
- Type: typing.Optional[str]
UserNameAttributeField
- Type: typing.Optional[str]
GroupAttributeField
- Type: typing.Optional[str]
Issuer
- Type: typing.Optional[str]
ClaimRegex
- Type: typing.Optional[str]
ListAccessControlConfigurationsRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListAccessControlConfigurationsResponse
AccessControlConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.AccessControlConfigurationSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListDataSourceSyncJobsRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
StartTimeFilter
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.TimeRange, aws_resource_validator.pydantic_models.kendra.kendra_classes.TimeRangeOutput, NoneType]
StatusFilter
- Type: typing.Optional[typing.Literal['ABORTED', 'FAILED', 'INCOMPLETE', 'STOPPING', 'SUCCEEDED', 'SYNCING', 'SYNCING_INDEXING']]
ListDataSourceSyncJobsResponse
History
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceSyncJob]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListDataSourcesRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListDataSourcesResponse
SummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListEntityPersonasRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListEntityPersonasResponse
SummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.PersonasSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListExperienceEntitiesRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListExperienceEntitiesResponse
SummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceEntitiesSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListExperiencesRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListExperiencesResponse
SummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperiencesSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListFaqsRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListFaqsResponse
FaqSummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FaqSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListFeaturedResultsSetsRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListFeaturedResultsSetsResponse
FeaturedResultsSetSummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedResultsSetSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListGroupsOlderThanOrderingIdRequest
IndexId
- Type:
- Required: Yes
OrderingId
- Type:
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListGroupsOlderThanOrderingIdResponse
GroupsSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.GroupSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListIndicesRequest
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListIndicesResponse
IndexConfigurationSummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.IndexConfigurationSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListQuerySuggestionsBlockListsRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListQuerySuggestionsBlockListsResponse
BlockListSummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.QuerySuggestionsBlockListSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
ListTagsForResourceRequest
ResourceARN
- Type:
- Required: Yes
ListTagsForResourceResponse
Tags
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListThesauriRequest
IndexId
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MaxResults
- Type: typing.Optional[int]
ListThesauriResponse
ThesaurusSummaryItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ThesaurusSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
NextToken
- Type: typing.Optional[str]
MemberGroup
GroupId
- Type:
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
MemberUser
UserId
- Type:
- Required: Yes
OnPremiseConfiguration
HostUrl
- Type:
- Required: Yes
OrganizationName
- Type:
- Required: Yes
SslCertificateS3Path
- Type:
- Required: Yes
OneDriveConfiguration
TenantDomain
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
OneDriveUsers
- Type:
- Required: Yes
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
DisableLocalGroups
- Type: typing.Optional[bool]
OneDriveConfigurationOutput
TenantDomain
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
OneDriveUsers
- Type:
- Required: Yes
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
DisableLocalGroups
- Type: typing.Optional[bool]
OneDriveUsers
OneDriveUserList
- Type: typing.Optional[typing.List[str]]
OneDriveUserS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
OneDriveUsersOutput
OneDriveUserList
- Type: typing.Optional[typing.List[str]]
OneDriveUserS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
PersonasSummary
EntityId
- Type: typing.Optional[str]
Persona
- Type: typing.Optional[typing.Literal['OWNER', 'VIEWER']]
CreatedAt
- Type: typing.Optional[datetime.datetime]
UpdatedAt
- Type: typing.Optional[datetime.datetime]
Principal
Name
- Type:
- Required: Yes
Type
- Type: typing.Literal['GROUP', 'USER']
- Required: Yes
Access
- Type: typing.Literal['ALLOW', 'DENY']
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
ProxyConfiguration
Host
- Type:
- Required: Yes
Port
- Type:
- Required: Yes
Credentials
- Type: typing.Optional[str]
PutPrincipalMappingRequest
IndexId
- Type:
- Required: Yes
GroupId
- Type:
- Required: Yes
GroupMembers
- Type:
- Required: Yes
DataSourceId
- Type: typing.Optional[str]
OrderingId
- Type: typing.Optional[int]
RoleArn
- Type: typing.Optional[str]
QueryRequest
IndexId
- Type:
- Required: Yes
QueryText
- Type: typing.Optional[str]
AttributeFilter
- Type:
Facets
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Facet]]
RequestedDocumentAttributes
- Type: typing.Optional[typing.List[str]]
QueryResultTypeFilter
- Type: typing.Optional[typing.Literal['ANSWER', 'DOCUMENT', 'QUESTION_ANSWER']]
DocumentRelevanceOverrideConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentRelevanceConfiguration]]
PageNumber
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
SortingConfiguration
- Type:
SortingConfigurations
- Type: typing.Optional[typing.List[NoneType]]
UserContext
- Type:
VisitorId
- Type: typing.Optional[str]
SpellCorrectionConfiguration
- Type:
CollapseConfiguration
- Type:
QueryResult
QueryId
- Type:
- Required: Yes
ResultItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.QueryResultItem]
- Required: Yes
FacetResults
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FacetResult]
- Required: Yes
TotalNumberOfResults
- Type:
- Required: Yes
Warnings
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Warning]
- Required: Yes
SpellCorrectedQueries
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SpellCorrectedQuery]
- Required: Yes
FeaturedResultsItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedResultsItem]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
QueryResultItem
Id
- Type: typing.Optional[str]
Type
- Type: typing.Optional[typing.Literal['ANSWER', 'DOCUMENT', 'QUESTION_ANSWER']]
Format
- Type: typing.Optional[typing.Literal['TABLE', 'TEXT']]
AdditionalAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.AdditionalResultAttribute]]
DocumentId
- Type: typing.Optional[str]
DocumentTitle
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentExcerpt
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.TextWithHighlights]
DocumentURI
- Type: typing.Optional[str]
DocumentAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]
ScoreAttributes
- Type:
FeedbackToken
- Type: typing.Optional[str]
TableExcerpt
- Type:
CollapsedResultDetail
- Type:
QuerySuggestionsBlockListSummary
Id
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'ACTIVE_BUT_UPDATE_FAILED', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]
CreatedAt
- Type: typing.Optional[datetime.datetime]
UpdatedAt
- Type: typing.Optional[datetime.datetime]
ItemCount
- Type: typing.Optional[int]
QuipConfiguration
Domain
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
CrawlFileComments
- Type: typing.Optional[bool]
CrawlChatRooms
- Type: typing.Optional[bool]
CrawlAttachments
- Type: typing.Optional[bool]
FolderIds
- Type: typing.Optional[typing.List[str]]
ThreadFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
MessageFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
QuipConfigurationOutput
Domain
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
CrawlFileComments
- Type: typing.Optional[bool]
CrawlChatRooms
- Type: typing.Optional[bool]
CrawlAttachments
- Type: typing.Optional[bool]
FolderIds
- Type: typing.Optional[typing.List[str]]
ThreadFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
MessageFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
AttachmentFieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
Relevance
Freshness
- Type: typing.Optional[bool]
Importance
- Type: typing.Optional[int]
Duration
- Type: typing.Optional[str]
RankOrder
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
ValueImportanceMap
- Type: typing.Optional[typing.Dict[str, int]]
RelevanceFeedback
ResultId
- Type:
- Required: Yes
RelevanceValue
- Type: typing.Literal['NOT_RELEVANT', 'RELEVANT']
- Required: Yes
RelevanceOutput
Freshness
- Type: typing.Optional[bool]
Importance
- Type: typing.Optional[int]
Duration
- Type: typing.Optional[str]
RankOrder
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
ValueImportanceMap
- Type: typing.Optional[typing.Dict[str, int]]
ResponseMetadata
RequestId
- Type:
- Required: Yes
HTTPStatusCode
- Type:
- Required: Yes
HTTPHeaders
- Type: typing.Dict[str, str]
- Required: Yes
RetryAttempts
- Type:
- Required: Yes
HostId
- Type: typing.Optional[str]
RetrieveRequest
IndexId
- Type:
- Required: Yes
QueryText
- Type:
- Required: Yes
AttributeFilter
- Type:
RequestedDocumentAttributes
- Type: typing.Optional[typing.List[str]]
DocumentRelevanceOverrideConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentRelevanceConfiguration]]
PageNumber
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
UserContext
- Type:
RetrieveResult
QueryId
- Type:
- Required: Yes
ResultItems
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.RetrieveResultItem]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
RetrieveResultItem
Id
- Type: typing.Optional[str]
DocumentId
- Type: typing.Optional[str]
DocumentTitle
- Type: typing.Optional[str]
Content
- Type: typing.Optional[str]
DocumentURI
- Type: typing.Optional[str]
DocumentAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]
ScoreAttributes
- Type:
S3DataSourceConfiguration
BucketName
- Type:
- Required: Yes
InclusionPrefixes
- Type: typing.Optional[typing.List[str]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
DocumentsMetadataConfiguration
- Type:
AccessControlListConfiguration
- Type:
S3DataSourceConfigurationOutput
BucketName
- Type:
- Required: Yes
InclusionPrefixes
- Type: typing.Optional[typing.List[str]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
DocumentsMetadataConfiguration
- Type:
AccessControlListConfiguration
- Type:
S3Path
Bucket
- Type:
- Required: Yes
Key
- Type:
- Required: Yes
SaaSConfiguration
OrganizationName
- Type:
- Required: Yes
HostUrl
- Type:
- Required: Yes
SalesforceChatterFeedConfiguration
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
IncludeFilterTypes
- Type: typing.Optional[typing.List[typing.Literal['ACTIVE_USER', 'STANDARD_USER']]]
SalesforceChatterFeedConfigurationOutput
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
IncludeFilterTypes
- Type: typing.Optional[typing.List[typing.Literal['ACTIVE_USER', 'STANDARD_USER']]]
SalesforceConfiguration
ServerUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
StandardObjectConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardObjectConfiguration]]
KnowledgeArticleConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceKnowledgeArticleConfiguration]
ChatterFeedConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceChatterFeedConfiguration]
CrawlAttachments
- Type: typing.Optional[bool]
StandardObjectAttachmentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardObjectAttachmentConfiguration]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
SalesforceConfigurationOutput
ServerUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
StandardObjectConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardObjectConfigurationOutput]]
KnowledgeArticleConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceKnowledgeArticleConfigurationOutput]
ChatterFeedConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceChatterFeedConfigurationOutput]
CrawlAttachments
- Type: typing.Optional[bool]
StandardObjectAttachmentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardObjectAttachmentConfigurationOutput]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
SalesforceCustomKnowledgeArticleTypeConfiguration
Name
- Type:
- Required: Yes
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceCustomKnowledgeArticleTypeConfigurationOutput
Name
- Type:
- Required: Yes
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceKnowledgeArticleConfiguration
IncludedStates
- Type: typing.List[typing.Literal['ARCHIVED', 'DRAFT', 'PUBLISHED']]
- Required: Yes
StandardKnowledgeArticleTypeConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardKnowledgeArticleTypeConfiguration]
CustomKnowledgeArticleTypeConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceCustomKnowledgeArticleTypeConfiguration]]
SalesforceKnowledgeArticleConfigurationOutput
IncludedStates
- Type: typing.List[typing.Literal['ARCHIVED', 'DRAFT', 'PUBLISHED']]
- Required: Yes
StandardKnowledgeArticleTypeConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceStandardKnowledgeArticleTypeConfigurationOutput]
CustomKnowledgeArticleTypeConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SalesforceCustomKnowledgeArticleTypeConfigurationOutput]]
SalesforceStandardKnowledgeArticleTypeConfiguration
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceStandardKnowledgeArticleTypeConfigurationOutput
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceStandardObjectAttachmentConfiguration
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceStandardObjectAttachmentConfigurationOutput
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceStandardObjectConfiguration
Name
- Type: typing.Literal['ACCOUNT', 'CAMPAIGN', 'CASE', 'CONTACT', 'CONTRACT', 'DOCUMENT', 'GROUP', 'IDEA', 'LEAD', 'OPPORTUNITY', 'PARTNER', 'PRICEBOOK', 'PRODUCT', 'PROFILE', 'SOLUTION', 'TASK', 'USER']
- Required: Yes
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SalesforceStandardObjectConfigurationOutput
Name
- Type: typing.Literal['ACCOUNT', 'CAMPAIGN', 'CASE', 'CONTACT', 'CONTRACT', 'DOCUMENT', 'GROUP', 'IDEA', 'LEAD', 'OPPORTUNITY', 'PARTNER', 'PRICEBOOK', 'PRODUCT', 'PROFILE', 'SOLUTION', 'TASK', 'USER']
- Required: Yes
DocumentDataFieldName
- Type:
- Required: Yes
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ScoreAttributes
ScoreConfidence
- Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NOT_AVAILABLE', 'VERY_HIGH']]
Search
Facetable
- Type: typing.Optional[bool]
Searchable
- Type: typing.Optional[bool]
Displayable
- Type: typing.Optional[bool]
Sortable
- Type: typing.Optional[bool]
SeedUrlConfiguration
SeedUrls
- Type: typing.List[str]
- Required: Yes
WebCrawlerMode
- Type: typing.Optional[typing.Literal['EVERYTHING', 'HOST_ONLY', 'SUBDOMAINS']]
SeedUrlConfigurationOutput
SeedUrls
- Type: typing.List[str]
- Required: Yes
WebCrawlerMode
- Type: typing.Optional[typing.Literal['EVERYTHING', 'HOST_ONLY', 'SUBDOMAINS']]
ServerSideEncryptionConfiguration
KmsKeyId
- Type: typing.Optional[str]
ServiceNowConfiguration
HostUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
ServiceNowBuildVersion
- Type: typing.Literal['LONDON', 'OTHERS']
- Required: Yes
KnowledgeArticleConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ServiceNowKnowledgeArticleConfiguration]
ServiceCatalogConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ServiceNowServiceCatalogConfiguration]
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'OAUTH2']]
ServiceNowConfigurationOutput
HostUrl
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
ServiceNowBuildVersion
- Type: typing.Literal['LONDON', 'OTHERS']
- Required: Yes
KnowledgeArticleConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ServiceNowKnowledgeArticleConfigurationOutput]
ServiceCatalogConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.ServiceNowServiceCatalogConfigurationOutput]
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'OAUTH2']]
ServiceNowKnowledgeArticleConfiguration
DocumentDataFieldName
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
FilterQuery
- Type: typing.Optional[str]
ServiceNowKnowledgeArticleConfigurationOutput
DocumentDataFieldName
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
FilterQuery
- Type: typing.Optional[str]
ServiceNowServiceCatalogConfiguration
DocumentDataFieldName
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
ServiceNowServiceCatalogConfigurationOutput
DocumentDataFieldName
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
IncludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
ExcludeAttachmentFilePatterns
- Type: typing.Optional[typing.List[str]]
DocumentTitleFieldName
- Type: typing.Optional[str]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SharePointConfiguration
SharePointVersion
- Type: typing.Literal['SHAREPOINT_2013', 'SHAREPOINT_2016', 'SHAREPOINT_2019', 'SHAREPOINT_ONLINE']
- Required: Yes
Urls
- Type: typing.List[str]
- Required: Yes
SecretArn
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
UseChangeLog
- Type: typing.Optional[bool]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
DocumentTitleFieldName
- Type: typing.Optional[str]
DisableLocalGroups
- Type: typing.Optional[bool]
SslCertificateS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'OAUTH2']]
ProxyConfiguration
- Type:
SharePointConfigurationOutput
SharePointVersion
- Type: typing.Literal['SHAREPOINT_2013', 'SHAREPOINT_2016', 'SHAREPOINT_2019', 'SHAREPOINT_ONLINE']
- Required: Yes
Urls
- Type: typing.List[str]
- Required: Yes
SecretArn
- Type:
- Required: Yes
CrawlAttachments
- Type: typing.Optional[bool]
UseChangeLog
- Type: typing.Optional[bool]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
DocumentTitleFieldName
- Type: typing.Optional[str]
DisableLocalGroups
- Type: typing.Optional[bool]
SslCertificateS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
AuthenticationType
- Type: typing.Optional[typing.Literal['HTTP_BASIC', 'OAUTH2']]
ProxyConfiguration
- Type:
SiteMapsConfiguration
SiteMaps
- Type: typing.List[str]
- Required: Yes
SiteMapsConfigurationOutput
SiteMaps
- Type: typing.List[str]
- Required: Yes
SlackConfiguration
TeamId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
SlackEntityList
- Type: typing.List[typing.Literal['DIRECT_MESSAGE', 'GROUP_MESSAGE', 'PRIVATE_CHANNEL', 'PUBLIC_CHANNEL']]
- Required: Yes
SinceCrawlDate
- Type:
- Required: Yes
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration]
UseChangeLog
- Type: typing.Optional[bool]
CrawlBotMessage
- Type: typing.Optional[bool]
ExcludeArchived
- Type: typing.Optional[bool]
LookBackPeriod
- Type: typing.Optional[int]
PrivateChannelFilter
- Type: typing.Optional[typing.List[str]]
PublicChannelFilter
- Type: typing.Optional[typing.List[str]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SlackConfigurationOutput
TeamId
- Type:
- Required: Yes
SecretArn
- Type:
- Required: Yes
SlackEntityList
- Type: typing.List[typing.Literal['DIRECT_MESSAGE', 'GROUP_MESSAGE', 'PRIVATE_CHANNEL', 'PUBLIC_CHANNEL']]
- Required: Yes
SinceCrawlDate
- Type:
- Required: Yes
VpcConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput]
UseChangeLog
- Type: typing.Optional[bool]
CrawlBotMessage
- Type: typing.Optional[bool]
ExcludeArchived
- Type: typing.Optional[bool]
LookBackPeriod
- Type: typing.Optional[int]
PrivateChannelFilter
- Type: typing.Optional[typing.List[str]]
PublicChannelFilter
- Type: typing.Optional[typing.List[str]]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
SortingConfiguration
DocumentAttributeKey
- Type:
- Required: Yes
SortOrder
- Type: typing.Literal['ASC', 'DESC']
- Required: Yes
SourceDocument
DocumentId
- Type: typing.Optional[str]
SuggestionAttributes
- Type: typing.Optional[typing.List[str]]
AdditionalAttributes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentAttributeOutput]]
SpellCorrectedQuery
SuggestedQueryText
- Type: typing.Optional[str]
Corrections
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Correction]]
SpellCorrectionConfiguration
IncludeQuerySpellCheckSuggestions
- Type:
- Required: Yes
SqlConfiguration
QueryIdentifiersEnclosingOption
- Type: typing.Optional[typing.Literal['DOUBLE_QUOTES', 'NONE']]
StartDataSourceSyncJobRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
StartDataSourceSyncJobResponse
ExecutionId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
Status
DocumentId
- Type: typing.Optional[str]
DocumentStatus
- Type: typing.Optional[typing.Literal['FAILED', 'INDEXED', 'NOT_FOUND', 'PROCESSING', 'UPDATED', 'UPDATE_FAILED']]
FailureCode
- Type: typing.Optional[str]
FailureReason
- Type: typing.Optional[str]
StopDataSourceSyncJobRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
SubmitFeedbackRequest
IndexId
- Type:
- Required: Yes
QueryId
- Type:
- Required: Yes
ClickFeedbackItems
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.ClickFeedback]]
RelevanceFeedbackItems
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.RelevanceFeedback]]
SuggestableConfig
AttributeName
- Type: typing.Optional[str]
Suggestable
- Type: typing.Optional[bool]
Suggestion
Id
- Type: typing.Optional[str]
Value
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SuggestionValue]
SourceDocuments
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SourceDocument]]
SuggestionHighlight
BeginOffset
- Type: typing.Optional[int]
EndOffset
- Type: typing.Optional[int]
SuggestionTextWithHighlights
Text
- Type: typing.Optional[str]
Highlights
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.SuggestionHighlight]]
SuggestionValue
Text
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SuggestionTextWithHighlights]
TableCell
Value
- Type: typing.Optional[str]
TopAnswer
- Type: typing.Optional[bool]
Highlighted
- Type: typing.Optional[bool]
Header
- Type: typing.Optional[bool]
TableExcerpt
Rows
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.TableRow]]
TotalNumberOfRows
- Type: typing.Optional[int]
TableRow
Cells
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.TableCell]]
Tag
Key
- Type:
- Required: Yes
Value
- Type:
- Required: Yes
TagResourceRequest
ResourceARN
- Type:
- Required: Yes
Tags
- Type: typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Tag]
- Required: Yes
TemplateConfiguration
Template
- Type: typing.Optional[typing.Dict[str, typing.Any]]
TemplateConfigurationOutput
Template
- Type: typing.Optional[typing.Dict[str, typing.Any]]
TextDocumentStatistics
IndexedTextDocumentsCount
- Type:
- Required: Yes
IndexedTextBytes
- Type:
- Required: Yes
TextWithHighlights
Text
- Type: typing.Optional[str]
Highlights
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Highlight]]
ThesaurusSummary
Id
- Type: typing.Optional[str]
Name
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'ACTIVE_BUT_UPDATE_FAILED', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]
CreatedAt
- Type: typing.Optional[datetime.datetime]
UpdatedAt
- Type: typing.Optional[datetime.datetime]
TimeRange
StartTime
- Type: typing.Union[datetime.datetime, str, NoneType]
EndTime
- Type: typing.Union[datetime.datetime, str, NoneType]
TimeRangeOutput
StartTime
- Type: typing.Optional[datetime.datetime]
EndTime
- Type: typing.Optional[datetime.datetime]
UntagResourceRequest
ResourceARN
- Type:
- Required: Yes
TagKeys
- Type: typing.List[str]
- Required: Yes
UpdateAccessControlConfigurationRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
AccessControlList
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.Principal]]
HierarchicalAccessControlList
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipal, aws_resource_validator.pydantic_models.kendra.kendra_classes.HierarchicalPrincipalOutput]]]
UpdateDataSourceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
Configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceConfigurationOutput, NoneType]
VpcConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceVpcConfigurationOutput, NoneType]
Description
- Type: typing.Optional[str]
Schedule
- Type: typing.Optional[str]
RoleArn
- Type: typing.Optional[str]
LanguageCode
- Type: typing.Optional[str]
CustomDocumentEnrichmentConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.CustomDocumentEnrichmentConfigurationOutput, NoneType]
UpdateExperienceRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
RoleArn
- Type: typing.Optional[str]
Configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.ExperienceConfigurationOutput, NoneType]
Description
- Type: typing.Optional[str]
UpdateFeaturedResultsSetRequest
IndexId
- Type:
- Required: Yes
FeaturedResultsSetId
- Type:
- Required: Yes
FeaturedResultsSetName
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
Status
- Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]
QueryTexts
- Type: typing.Optional[typing.List[str]]
FeaturedDocuments
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.FeaturedDocument]]
UpdateFeaturedResultsSetResponse
FeaturedResultsSet
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateIndexRequest
Id
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
RoleArn
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
DocumentMetadataConfigurationUpdates
- Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentMetadataConfiguration, aws_resource_validator.pydantic_models.kendra.kendra_classes.DocumentMetadataConfigurationOutput]]]
CapacityUnits
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.CapacityUnitsConfiguration]
UserTokenConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.UserTokenConfiguration]]
UserContextPolicy
- Type: typing.Optional[typing.Literal['ATTRIBUTE_FILTER', 'USER_TOKEN']]
UserGroupResolutionConfiguration
- Type:
UpdateQuerySuggestionsBlockListRequest
IndexId
- Type:
- Required: Yes
Id
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
SourceS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
RoleArn
- Type: typing.Optional[str]
UpdateQuerySuggestionsConfigRequest
IndexId
- Type:
- Required: Yes
Mode
- Type: typing.Optional[typing.Literal['ENABLED', 'LEARN_ONLY']]
QueryLogLookBackWindowInDays
- Type: typing.Optional[int]
IncludeQueriesWithoutUserInformation
- Type: typing.Optional[bool]
MinimumNumberOfQueryingUsers
- Type: typing.Optional[int]
MinimumQueryCount
- Type: typing.Optional[int]
AttributeSuggestionsConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.AttributeSuggestionsUpdateConfig]
UpdateThesaurusRequest
Id
- Type:
- Required: Yes
IndexId
- Type:
- Required: Yes
Name
- Type: typing.Optional[str]
Description
- Type: typing.Optional[str]
RoleArn
- Type: typing.Optional[str]
SourceS3Path
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.S3Path]
Urls
SeedUrlConfiguration
- Type:
SiteMapsConfiguration
- Type:
UrlsOutput
SeedUrlConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SeedUrlConfigurationOutput]
SiteMapsConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.SiteMapsConfigurationOutput]
UserContext
Token
- Type: typing.Optional[str]
UserId
- Type: typing.Optional[str]
Groups
- Type: typing.Optional[typing.List[str]]
DataSourceGroups
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceGroup]]
UserGroupResolutionConfiguration
UserGroupResolutionMode
- Type: typing.Literal['AWS_SSO', 'NONE']
- Required: Yes
UserIdentityConfiguration
IdentityAttributeName
- Type: typing.Optional[str]
UserTokenConfiguration
JwtTokenTypeConfiguration
- Type:
JsonTokenTypeConfiguration
- Type:
Warning
Message
- Type: typing.Optional[str]
Code
- Type: typing.Optional[typing.Literal['QUERY_LANGUAGE_INVALID_SYNTAX']]
WebCrawlerConfiguration
Urls
- Type:
- Required: Yes
CrawlDepth
- Type: typing.Optional[int]
MaxLinksPerPage
- Type: typing.Optional[int]
MaxContentSizePerPageInMegaBytes
- Type: typing.Optional[float]
MaxUrlsPerMinuteCrawlRate
- Type: typing.Optional[int]
UrlInclusionPatterns
- Type: typing.Optional[typing.List[str]]
UrlExclusionPatterns
- Type: typing.Optional[typing.List[str]]
ProxyConfiguration
- Type:
AuthenticationConfiguration
- Type:
WebCrawlerConfigurationOutput
Urls
- Type:
- Required: Yes
CrawlDepth
- Type: typing.Optional[int]
MaxLinksPerPage
- Type: typing.Optional[int]
MaxContentSizePerPageInMegaBytes
- Type: typing.Optional[float]
MaxUrlsPerMinuteCrawlRate
- Type: typing.Optional[int]
UrlInclusionPatterns
- Type: typing.Optional[typing.List[str]]
UrlExclusionPatterns
- Type: typing.Optional[typing.List[str]]
ProxyConfiguration
- Type:
AuthenticationConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.kendra.kendra_classes.AuthenticationConfigurationOutput]
WorkDocsConfiguration
OrganizationId
- Type:
- Required: Yes
CrawlComments
- Type: typing.Optional[bool]
UseChangeLog
- Type: typing.Optional[bool]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]
WorkDocsConfigurationOutput
OrganizationId
- Type:
- Required: Yes
CrawlComments
- Type: typing.Optional[bool]
UseChangeLog
- Type: typing.Optional[bool]
InclusionPatterns
- Type: typing.Optional[typing.List[str]]
ExclusionPatterns
- Type: typing.Optional[typing.List[str]]
FieldMappings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra.kendra_classes.DataSourceToIndexFieldMapping]]