Kendra module#
Index > Kendra
Auto-generated documentation for Kendra type annotations stubs module mypy-boto3-kendra.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Kendra
.
From PyPI with pip#
Install boto3-stubs
for Kendra
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[kendra]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[kendra]'
# standalone installation
python -m pip install mypy-boto3-kendra
How to uninstall#
python -m pip uninstall -y mypy-boto3-kendra
Usage#
Code samples can be found in Examples.
KendraClient#
Type annotations and code completion for boto3.client("kendra")
as KendraClient
boto3 documentation
# KendraClient usage example
from boto3.session import Session
from mypy_boto3_kendra.client import KendraClient
def get_client() -> KendraClient:
return Session().client("kendra")
Literals#
Type annotations for literals used in methods and schema.
# AdditionalResultAttributeValueTypeType usage example
from mypy_boto3_kendra.literals import AdditionalResultAttributeValueTypeType
def get_value() -> AdditionalResultAttributeValueTypeType:
return "TEXT_WITH_HIGHLIGHTS_VALUE"
- AdditionalResultAttributeValueTypeType
- AlfrescoEntityType
- AttributeSuggestionsModeType
- ConditionOperatorType
- ConfluenceAttachmentFieldNameType
- ConfluenceAuthenticationTypeType
- ConfluenceBlogFieldNameType
- ConfluencePageFieldNameType
- ConfluenceSpaceFieldNameType
- ConfluenceVersionType
- ContentTypeType
- DataSourceStatusType
- DataSourceSyncJobStatusType
- DataSourceTypeType
- DatabaseEngineTypeType
- DocumentAttributeValueTypeType
- DocumentStatusType
- EndpointTypeType
- EntityTypeType
- ErrorCodeType
- ExperienceStatusType
- FaqFileFormatType
- FaqStatusType
- FeaturedResultsSetStatusType
- FsxFileSystemTypeType
- HighlightTypeType
- IndexEditionType
- IndexStatusType
- IntervalType
- IssueSubEntityType
- KeyLocationType
- MetricTypeType
- MissingAttributeKeyStrategyType
- ModeType
- OrderType
- PersonaType
- PrincipalMappingStatusType
- PrincipalTypeType
- QueryIdentifiersEnclosingOptionType
- QueryResultFormatType
- QueryResultTypeType
- QuerySuggestionsBlockListStatusType
- QuerySuggestionsStatusType
- ReadAccessTypeType
- RelevanceTypeType
- SalesforceChatterFeedIncludeFilterTypeType
- SalesforceKnowledgeArticleStateType
- SalesforceStandardObjectNameType
- ScoreConfidenceType
- ServiceNowAuthenticationTypeType
- ServiceNowBuildVersionTypeType
- SharePointOnlineAuthenticationTypeType
- SharePointVersionType
- SlackEntityType
- SortOrderType
- SuggestionTypeType
- ThesaurusStatusType
- TypeType
- UserContextPolicyType
- UserGroupResolutionModeType
- WarningCodeType
- WebCrawlerModeType
- KendraServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessControlConfigurationSummaryTypeDef
- AccessControlListConfigurationTypeDef
- AclConfigurationTypeDef
- DataSourceToIndexFieldMappingTypeDef
- DataSourceVpcConfigurationOutputTypeDef
- S3PathTypeDef
- DataSourceVpcConfigurationTypeDef
- EntityConfigurationTypeDef
- FailedEntityTypeDef
- ResponseMetadataTypeDef
- EntityPersonaConfigurationTypeDef
- SuggestableConfigTypeDef
- BasicAuthenticationConfigurationTypeDef
- DataSourceSyncJobMetricTargetTypeDef
- BatchDeleteDocumentResponseFailedDocumentTypeDef
- BatchDeleteFeaturedResultsSetErrorTypeDef
- BatchDeleteFeaturedResultsSetRequestRequestTypeDef
- BatchGetDocumentStatusResponseErrorTypeDef
- StatusTypeDef
- BatchPutDocumentResponseFailedDocumentTypeDef
- BlobTypeDef
- CapacityUnitsConfigurationTypeDef
- ClearQuerySuggestionsRequestRequestTypeDef
- TimestampTypeDef
- ExpandConfigurationTypeDef
- SortingConfigurationTypeDef
- ConfluenceAttachmentToIndexFieldMappingTypeDef
- ConfluenceBlogToIndexFieldMappingTypeDef
- ProxyConfigurationTypeDef
- ConfluencePageToIndexFieldMappingTypeDef
- ConfluenceSpaceToIndexFieldMappingTypeDef
- ConnectionConfigurationTypeDef
- ContentSourceConfigurationOutputTypeDef
- ContentSourceConfigurationTypeDef
- CorrectionTypeDef
- PrincipalTypeDef
- TagTypeDef
- FeaturedDocumentTypeDef
- ServerSideEncryptionConfigurationTypeDef
- UserGroupResolutionConfigurationTypeDef
- TemplateConfigurationOutputTypeDef
- TemplateConfigurationTypeDef
- DataSourceGroupTypeDef
- DataSourceSummaryTypeDef
- DataSourceSyncJobMetricsTypeDef
- SqlConfigurationTypeDef
- DeleteAccessControlConfigurationRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteExperienceRequestRequestTypeDef
- DeleteFaqRequestRequestTypeDef
- DeleteIndexRequestRequestTypeDef
- DeletePrincipalMappingRequestRequestTypeDef
- DeleteQuerySuggestionsBlockListRequestRequestTypeDef
- DeleteThesaurusRequestRequestTypeDef
- DescribeAccessControlConfigurationRequestRequestTypeDef
- DescribeDataSourceRequestRequestTypeDef
- DescribeExperienceRequestRequestTypeDef
- ExperienceEndpointTypeDef
- DescribeFaqRequestRequestTypeDef
- DescribeFeaturedResultsSetRequestRequestTypeDef
- FeaturedDocumentMissingTypeDef
- FeaturedDocumentWithMetadataTypeDef
- DescribeIndexRequestRequestTypeDef
- DescribePrincipalMappingRequestRequestTypeDef
- GroupOrderingIdSummaryTypeDef
- DescribeQuerySuggestionsBlockListRequestRequestTypeDef
- DescribeQuerySuggestionsConfigRequestRequestTypeDef
- DescribeThesaurusRequestRequestTypeDef
- DisassociatePersonasFromEntitiesRequestRequestTypeDef
- DocumentAttributeValueOutputTypeDef
- RelevanceOutputTypeDef
- SearchTypeDef
- RelevanceTypeDef
- DocumentsMetadataConfigurationTypeDef
- EntityDisplayDataTypeDef
- UserIdentityConfigurationTypeDef
- FacetResultTypeDef
- FacetTypeDef
- FaqStatisticsTypeDef
- FaqSummaryTypeDef
- FeaturedResultsSetSummaryTypeDef
- GetSnapshotsRequestRequestTypeDef
- TimeRangeOutputTypeDef
- GitHubDocumentCrawlPropertiesTypeDef
- SaaSConfigurationTypeDef
- MemberGroupTypeDef
- MemberUserTypeDef
- GroupSummaryTypeDef
- HighlightTypeDef
- IndexConfigurationSummaryTypeDef
- TextDocumentStatisticsTypeDef
- JsonTokenTypeConfigurationTypeDef
- JwtTokenTypeConfigurationTypeDef
- ListAccessControlConfigurationsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListEntityPersonasRequestRequestTypeDef
- PersonasSummaryTypeDef
- ListExperienceEntitiesRequestRequestTypeDef
- ListExperiencesRequestRequestTypeDef
- ListFaqsRequestRequestTypeDef
- ListFeaturedResultsSetsRequestRequestTypeDef
- ListGroupsOlderThanOrderingIdRequestRequestTypeDef
- ListIndicesRequestRequestTypeDef
- ListQuerySuggestionsBlockListsRequestRequestTypeDef
- QuerySuggestionsBlockListSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListThesauriRequestRequestTypeDef
- ThesaurusSummaryTypeDef
- SpellCorrectionConfigurationTypeDef
- ScoreAttributesTypeDef
- WarningTypeDef
- RelevanceFeedbackTypeDef
- SeedUrlConfigurationOutputTypeDef
- SeedUrlConfigurationTypeDef
- SiteMapsConfigurationOutputTypeDef
- SiteMapsConfigurationTypeDef
- StartDataSourceSyncJobRequestRequestTypeDef
- StopDataSourceSyncJobRequestRequestTypeDef
- SuggestionHighlightTypeDef
- TableCellTypeDef
- UntagResourceRequestRequestTypeDef
- ColumnConfigurationOutputTypeDef
- ColumnConfigurationTypeDef
- GoogleDriveConfigurationOutputTypeDef
- GoogleDriveConfigurationTypeDef
- SalesforceChatterFeedConfigurationOutputTypeDef
- SalesforceChatterFeedConfigurationTypeDef
- SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef
- SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
- SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef
- SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
- SalesforceStandardObjectAttachmentConfigurationOutputTypeDef
- SalesforceStandardObjectAttachmentConfigurationTypeDef
- SalesforceStandardObjectConfigurationOutputTypeDef
- SalesforceStandardObjectConfigurationTypeDef
- ServiceNowKnowledgeArticleConfigurationOutputTypeDef
- ServiceNowKnowledgeArticleConfigurationTypeDef
- ServiceNowServiceCatalogConfigurationOutputTypeDef
- ServiceNowServiceCatalogConfigurationTypeDef
- WorkDocsConfigurationOutputTypeDef
- WorkDocsConfigurationTypeDef
- BoxConfigurationOutputTypeDef
- FsxConfigurationOutputTypeDef
- JiraConfigurationOutputTypeDef
- QuipConfigurationOutputTypeDef
- SlackConfigurationOutputTypeDef
- AlfrescoConfigurationOutputTypeDef
- OnPremiseConfigurationTypeDef
- OneDriveUsersOutputTypeDef
- OneDriveUsersTypeDef
- UpdateQuerySuggestionsBlockListRequestRequestTypeDef
- UpdateThesaurusRequestRequestTypeDef
- AlfrescoConfigurationTypeDef
- BoxConfigurationTypeDef
- DataSourceVpcConfigurationUnionTypeDef
- FsxConfigurationTypeDef
- JiraConfigurationTypeDef
- QuipConfigurationTypeDef
- SlackConfigurationTypeDef
- AssociateEntitiesToExperienceRequestRequestTypeDef
- DisassociateEntitiesFromExperienceRequestRequestTypeDef
- AssociateEntitiesToExperienceResponseTypeDef
- AssociatePersonasToEntitiesResponseTypeDef
- CreateAccessControlConfigurationResponseTypeDef
- CreateDataSourceResponseTypeDef
- CreateExperienceResponseTypeDef
- CreateFaqResponseTypeDef
- CreateIndexResponseTypeDef
- CreateQuerySuggestionsBlockListResponseTypeDef
- CreateThesaurusResponseTypeDef
- DescribeFaqResponseTypeDef
- DescribeQuerySuggestionsBlockListResponseTypeDef
- DescribeThesaurusResponseTypeDef
- DisassociateEntitiesFromExperienceResponseTypeDef
- DisassociatePersonasFromEntitiesResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListAccessControlConfigurationsResponseTypeDef
- StartDataSourceSyncJobResponseTypeDef
- AssociatePersonasToEntitiesRequestRequestTypeDef
- AttributeSuggestionsDescribeConfigTypeDef
- AttributeSuggestionsUpdateConfigTypeDef
- AuthenticationConfigurationOutputTypeDef
- AuthenticationConfigurationTypeDef
- BatchDeleteDocumentRequestRequestTypeDef
- BatchDeleteDocumentResponseTypeDef
- BatchDeleteFeaturedResultsSetResponseTypeDef
- BatchGetDocumentStatusResponseTypeDef
- BatchPutDocumentResponseTypeDef
- ClickFeedbackTypeDef
- DocumentAttributeValueTypeDef
- TimeRangeTypeDef
- CollapseConfigurationTypeDef
- ConfluenceAttachmentConfigurationOutputTypeDef
- ConfluenceAttachmentConfigurationTypeDef
- ConfluenceBlogConfigurationOutputTypeDef
- ConfluenceBlogConfigurationTypeDef
- SharePointConfigurationOutputTypeDef
- SharePointConfigurationTypeDef
- ConfluencePageConfigurationOutputTypeDef
- ConfluencePageConfigurationTypeDef
- ConfluenceSpaceConfigurationOutputTypeDef
- ConfluenceSpaceConfigurationTypeDef
- SpellCorrectedQueryTypeDef
- HierarchicalPrincipalOutputTypeDef
- HierarchicalPrincipalTypeDef
- CreateFaqRequestRequestTypeDef
- CreateQuerySuggestionsBlockListRequestRequestTypeDef
- CreateThesaurusRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- CreateFeaturedResultsSetRequestRequestTypeDef
- FeaturedResultsSetTypeDef
- UpdateFeaturedResultsSetRequestRequestTypeDef
- UserContextTypeDef
- ListDataSourcesResponseTypeDef
- DataSourceSyncJobTypeDef
- ExperiencesSummaryTypeDef
- DescribeFeaturedResultsSetResponseTypeDef
- DescribePrincipalMappingResponseTypeDef
- DocumentAttributeConditionOutputTypeDef
- DocumentAttributeOutputTypeDef
- DocumentAttributeTargetOutputTypeDef
- DocumentAttributeValueCountPairTypeDef
- DocumentMetadataConfigurationOutputTypeDef
- DocumentMetadataConfigurationTypeDef
- DocumentRelevanceConfigurationTypeDef
- S3DataSourceConfigurationOutputTypeDef
- S3DataSourceConfigurationTypeDef
- ExperienceEntitiesSummaryTypeDef
- ExperienceConfigurationOutputTypeDef
- ExperienceConfigurationTypeDef
- ListFaqsResponseTypeDef
- ListFeaturedResultsSetsResponseTypeDef
- GetSnapshotsResponseTypeDef
- GroupMembersTypeDef
- ListGroupsOlderThanOrderingIdResponseTypeDef
- TextWithHighlightsTypeDef
- ListIndicesResponseTypeDef
- IndexStatisticsTypeDef
- UserTokenConfigurationTypeDef
- ListEntityPersonasResponseTypeDef
- ListQuerySuggestionsBlockListsResponseTypeDef
- ListThesauriResponseTypeDef
- UrlsOutputTypeDef
- UrlsTypeDef
- SuggestionTextWithHighlightsTypeDef
- TableRowTypeDef
- DatabaseConfigurationOutputTypeDef
- DatabaseConfigurationTypeDef
- SalesforceKnowledgeArticleConfigurationOutputTypeDef
- SalesforceKnowledgeArticleConfigurationTypeDef
- ServiceNowConfigurationOutputTypeDef
- ServiceNowConfigurationTypeDef
- GitHubConfigurationOutputTypeDef
- GitHubConfigurationTypeDef
- OneDriveConfigurationOutputTypeDef
- OneDriveConfigurationTypeDef
- DescribeQuerySuggestionsConfigResponseTypeDef
- UpdateQuerySuggestionsConfigRequestRequestTypeDef
- SubmitFeedbackRequestRequestTypeDef
- DocumentAttributeConditionTypeDef
- DocumentAttributeTargetTypeDef
- DocumentAttributeTypeDef
- ListDataSourceSyncJobsRequestRequestTypeDef
- TimeRangeUnionTypeDef
- ConfluenceConfigurationOutputTypeDef
- ConfluenceConfigurationTypeDef
- DescribeAccessControlConfigurationResponseTypeDef
- HierarchicalPrincipalUnionTypeDef
- CreateFeaturedResultsSetResponseTypeDef
- UpdateFeaturedResultsSetResponseTypeDef
- AttributeSuggestionsGetConfigTypeDef
- ListDataSourceSyncJobsResponseTypeDef
- ListExperiencesResponseTypeDef
- HookConfigurationOutputTypeDef
- RetrieveResultItemTypeDef
- SourceDocumentTypeDef
- InlineCustomDocumentEnrichmentConfigurationOutputTypeDef
- DocumentMetadataConfigurationUnionTypeDef
- QueryRequestRequestTypeDef
- RetrieveRequestRequestTypeDef
- ListExperienceEntitiesResponseTypeDef
- DescribeExperienceResponseTypeDef
- CreateExperienceRequestRequestTypeDef
- ExperienceConfigurationUnionTypeDef
- UpdateExperienceRequestRequestTypeDef
- PutPrincipalMappingRequestRequestTypeDef
- AdditionalResultAttributeValueTypeDef
- ExpandedResultItemTypeDef
- CreateIndexRequestRequestTypeDef
- DescribeIndexResponseTypeDef
- WebCrawlerConfigurationOutputTypeDef
- WebCrawlerConfigurationTypeDef
- SuggestionValueTypeDef
- TableExcerptTypeDef
- SalesforceConfigurationOutputTypeDef
- SalesforceConfigurationTypeDef
- HookConfigurationTypeDef
- InlineCustomDocumentEnrichmentConfigurationTypeDef
- AttributeFilterTypeDef
- DocumentInfoTypeDef
- DocumentTypeDef
- CreateAccessControlConfigurationRequestRequestTypeDef
- UpdateAccessControlConfigurationRequestRequestTypeDef
- GetQuerySuggestionsRequestRequestTypeDef
- RetrieveResultTypeDef
- CustomDocumentEnrichmentConfigurationOutputTypeDef
- UpdateIndexRequestRequestTypeDef
- AdditionalResultAttributeTypeDef
- CollapsedResultDetailTypeDef
- SuggestionTypeDef
- DataSourceConfigurationOutputTypeDef
- DataSourceConfigurationTypeDef
- CustomDocumentEnrichmentConfigurationTypeDef
- BatchGetDocumentStatusRequestRequestTypeDef
- FeaturedResultsItemTypeDef
- QueryResultItemTypeDef
- GetQuerySuggestionsResponseTypeDef
- DescribeDataSourceResponseTypeDef
- DataSourceConfigurationUnionTypeDef
- BatchPutDocumentRequestRequestTypeDef
- CreateDataSourceRequestRequestTypeDef
- CustomDocumentEnrichmentConfigurationUnionTypeDef
- UpdateDataSourceRequestRequestTypeDef
- QueryResultTypeDef