Type definitions#
Auto-generated documentation for Kendra type annotations stubs module types-boto3-kendra.
BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_kendra.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_kendra.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime.datetime,
str,
]DataSourceVpcConfigurationUnionTypeDef#
# DataSourceVpcConfigurationUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import DataSourceVpcConfigurationUnionTypeDef
def get_value() -> DataSourceVpcConfigurationUnionTypeDef:
return ...
# DataSourceVpcConfigurationUnionTypeDef definition
DataSourceVpcConfigurationUnionTypeDef = Union[
DataSourceVpcConfigurationTypeDef, # (1)
DataSourceVpcConfigurationOutputTypeDef, # (2)
]RelevanceUnionTypeDef#
# RelevanceUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import RelevanceUnionTypeDef
def get_value() -> RelevanceUnionTypeDef:
return ...
# RelevanceUnionTypeDef definition
RelevanceUnionTypeDef = Union[
RelevanceTypeDef, # (1)
RelevanceOutputTypeDef, # (2)
]DocumentAttributeValueUnionTypeDef#
# DocumentAttributeValueUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import DocumentAttributeValueUnionTypeDef
def get_value() -> DocumentAttributeValueUnionTypeDef:
return ...
# DocumentAttributeValueUnionTypeDef definition
DocumentAttributeValueUnionTypeDef = Union[
DocumentAttributeValueTypeDef, # (1)
DocumentAttributeValueOutputTypeDef, # (2)
]TimeRangeUnionTypeDef#
# TimeRangeUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import TimeRangeUnionTypeDef
def get_value() -> TimeRangeUnionTypeDef:
return ...
# TimeRangeUnionTypeDef definition
TimeRangeUnionTypeDef = Union[
TimeRangeTypeDef, # (1)
TimeRangeOutputTypeDef, # (2)
]HierarchicalPrincipalUnionTypeDef#
# HierarchicalPrincipalUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import HierarchicalPrincipalUnionTypeDef
def get_value() -> HierarchicalPrincipalUnionTypeDef:
return ...
# HierarchicalPrincipalUnionTypeDef definition
HierarchicalPrincipalUnionTypeDef = Union[
HierarchicalPrincipalTypeDef, # (1)
HierarchicalPrincipalOutputTypeDef, # (2)
]ExperienceConfigurationUnionTypeDef#
# ExperienceConfigurationUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import ExperienceConfigurationUnionTypeDef
def get_value() -> ExperienceConfigurationUnionTypeDef:
return ...
# ExperienceConfigurationUnionTypeDef definition
ExperienceConfigurationUnionTypeDef = Union[
ExperienceConfigurationTypeDef, # (1)
ExperienceConfigurationOutputTypeDef, # (2)
]DocumentMetadataConfigurationUnionTypeDef#
# DocumentMetadataConfigurationUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import DocumentMetadataConfigurationUnionTypeDef
def get_value() -> DocumentMetadataConfigurationUnionTypeDef:
return ...
# DocumentMetadataConfigurationUnionTypeDef definition
DocumentMetadataConfigurationUnionTypeDef = Union[
DocumentMetadataConfigurationTypeDef, # (1)
DocumentMetadataConfigurationOutputTypeDef, # (2)
]DocumentAttributeUnionTypeDef#
# DocumentAttributeUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import DocumentAttributeUnionTypeDef
def get_value() -> DocumentAttributeUnionTypeDef:
return ...
# DocumentAttributeUnionTypeDef definition
DocumentAttributeUnionTypeDef = Union[
DocumentAttributeTypeDef, # (1)
DocumentAttributeOutputTypeDef, # (2)
]DataSourceConfigurationUnionTypeDef#
# DataSourceConfigurationUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import DataSourceConfigurationUnionTypeDef
def get_value() -> DataSourceConfigurationUnionTypeDef:
return ...
# DataSourceConfigurationUnionTypeDef definition
DataSourceConfigurationUnionTypeDef = Union[
DataSourceConfigurationTypeDef, # (1)
DataSourceConfigurationOutputTypeDef, # (2)
]CustomDocumentEnrichmentConfigurationUnionTypeDef#
# CustomDocumentEnrichmentConfigurationUnionTypeDef Union usage example
from types_boto3_kendra.type_defs import CustomDocumentEnrichmentConfigurationUnionTypeDef
def get_value() -> CustomDocumentEnrichmentConfigurationUnionTypeDef:
return ...
# CustomDocumentEnrichmentConfigurationUnionTypeDef definition
CustomDocumentEnrichmentConfigurationUnionTypeDef = Union[
CustomDocumentEnrichmentConfigurationTypeDef, # (1)
CustomDocumentEnrichmentConfigurationOutputTypeDef, # (2)
]- See CustomDocumentEnrichmentConfigurationTypeDef
- See CustomDocumentEnrichmentConfigurationOutputTypeDef
AccessControlConfigurationSummaryTypeDef#
# AccessControlConfigurationSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AccessControlConfigurationSummaryTypeDef
def get_value() -> AccessControlConfigurationSummaryTypeDef:
return {
"Id": ...,
}
# AccessControlConfigurationSummaryTypeDef definition
class AccessControlConfigurationSummaryTypeDef(TypedDict):
Id: str,AccessControlListConfigurationTypeDef#
# AccessControlListConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AccessControlListConfigurationTypeDef
def get_value() -> AccessControlListConfigurationTypeDef:
return {
"KeyPath": ...,
}
# AccessControlListConfigurationTypeDef definition
class AccessControlListConfigurationTypeDef(TypedDict):
KeyPath: NotRequired[str],AclConfigurationTypeDef#
# AclConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AclConfigurationTypeDef
def get_value() -> AclConfigurationTypeDef:
return {
"AllowedGroupsColumnName": ...,
}
# AclConfigurationTypeDef definition
class AclConfigurationTypeDef(TypedDict):
AllowedGroupsColumnName: str,DataSourceToIndexFieldMappingTypeDef#
# DataSourceToIndexFieldMappingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceToIndexFieldMappingTypeDef
def get_value() -> DataSourceToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
# DataSourceToIndexFieldMappingTypeDef definition
class DataSourceToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: str,
IndexFieldName: str,
DateFieldFormat: NotRequired[str],DataSourceVpcConfigurationOutputTypeDef#
# DataSourceVpcConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceVpcConfigurationOutputTypeDef
def get_value() -> DataSourceVpcConfigurationOutputTypeDef:
return {
"SubnetIds": ...,
}
# DataSourceVpcConfigurationOutputTypeDef definition
class DataSourceVpcConfigurationOutputTypeDef(TypedDict):
SubnetIds: List[str],
SecurityGroupIds: List[str],S3PathTypeDef#
# S3PathTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import S3PathTypeDef
def get_value() -> S3PathTypeDef:
return {
"Bucket": ...,
}
# S3PathTypeDef definition
class S3PathTypeDef(TypedDict):
Bucket: str,
Key: str,DataSourceVpcConfigurationTypeDef#
# DataSourceVpcConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceVpcConfigurationTypeDef
def get_value() -> DataSourceVpcConfigurationTypeDef:
return {
"SubnetIds": ...,
}
# DataSourceVpcConfigurationTypeDef definition
class DataSourceVpcConfigurationTypeDef(TypedDict):
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],EntityConfigurationTypeDef#
# EntityConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import EntityConfigurationTypeDef
def get_value() -> EntityConfigurationTypeDef:
return {
"EntityId": ...,
}
# EntityConfigurationTypeDef definition
class EntityConfigurationTypeDef(TypedDict):
EntityId: str,
EntityType: EntityTypeType, # (1)- See EntityTypeType
FailedEntityTypeDef#
# FailedEntityTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FailedEntityTypeDef
def get_value() -> FailedEntityTypeDef:
return {
"EntityId": ...,
}
# FailedEntityTypeDef definition
class FailedEntityTypeDef(TypedDict):
EntityId: NotRequired[str],
ErrorMessage: NotRequired[str],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],EntityPersonaConfigurationTypeDef#
# EntityPersonaConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import EntityPersonaConfigurationTypeDef
def get_value() -> EntityPersonaConfigurationTypeDef:
return {
"EntityId": ...,
}
# EntityPersonaConfigurationTypeDef definition
class EntityPersonaConfigurationTypeDef(TypedDict):
EntityId: str,
Persona: PersonaType, # (1)- See PersonaType
SuggestableConfigTypeDef#
# SuggestableConfigTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SuggestableConfigTypeDef
def get_value() -> SuggestableConfigTypeDef:
return {
"AttributeName": ...,
}
# SuggestableConfigTypeDef definition
class SuggestableConfigTypeDef(TypedDict):
AttributeName: NotRequired[str],
Suggestable: NotRequired[bool],BasicAuthenticationConfigurationTypeDef#
# BasicAuthenticationConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BasicAuthenticationConfigurationTypeDef
def get_value() -> BasicAuthenticationConfigurationTypeDef:
return {
"Host": ...,
}
# BasicAuthenticationConfigurationTypeDef definition
class BasicAuthenticationConfigurationTypeDef(TypedDict):
Host: str,
Port: int,
Credentials: str,DataSourceSyncJobMetricTargetTypeDef#
# DataSourceSyncJobMetricTargetTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceSyncJobMetricTargetTypeDef
def get_value() -> DataSourceSyncJobMetricTargetTypeDef:
return {
"DataSourceId": ...,
}
# DataSourceSyncJobMetricTargetTypeDef definition
class DataSourceSyncJobMetricTargetTypeDef(TypedDict):
DataSourceId: str,
DataSourceSyncJobId: NotRequired[str],BatchDeleteDocumentResponseFailedDocumentTypeDef#
# BatchDeleteDocumentResponseFailedDocumentTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteDocumentResponseFailedDocumentTypeDef
def get_value() -> BatchDeleteDocumentResponseFailedDocumentTypeDef:
return {
"Id": ...,
}
# BatchDeleteDocumentResponseFailedDocumentTypeDef definition
class BatchDeleteDocumentResponseFailedDocumentTypeDef(TypedDict):
Id: NotRequired[str],
DataSourceId: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],- See ErrorCodeType
BatchDeleteFeaturedResultsSetErrorTypeDef#
# BatchDeleteFeaturedResultsSetErrorTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetErrorTypeDef
def get_value() -> BatchDeleteFeaturedResultsSetErrorTypeDef:
return {
"Id": ...,
}
# BatchDeleteFeaturedResultsSetErrorTypeDef definition
class BatchDeleteFeaturedResultsSetErrorTypeDef(TypedDict):
Id: str,
ErrorCode: ErrorCodeType, # (1)
ErrorMessage: str,- See ErrorCodeType
BatchDeleteFeaturedResultsSetRequestTypeDef#
# BatchDeleteFeaturedResultsSetRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetRequestTypeDef
def get_value() -> BatchDeleteFeaturedResultsSetRequestTypeDef:
return {
"IndexId": ...,
}
# BatchDeleteFeaturedResultsSetRequestTypeDef definition
class BatchDeleteFeaturedResultsSetRequestTypeDef(TypedDict):
IndexId: str,
FeaturedResultsSetIds: Sequence[str],BatchGetDocumentStatusResponseErrorTypeDef#
# BatchGetDocumentStatusResponseErrorTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchGetDocumentStatusResponseErrorTypeDef
def get_value() -> BatchGetDocumentStatusResponseErrorTypeDef:
return {
"DocumentId": ...,
}
# BatchGetDocumentStatusResponseErrorTypeDef definition
class BatchGetDocumentStatusResponseErrorTypeDef(TypedDict):
DocumentId: NotRequired[str],
DataSourceId: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],- See ErrorCodeType
StatusTypeDef#
# StatusTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import StatusTypeDef
def get_value() -> StatusTypeDef:
return {
"DocumentId": ...,
}
# StatusTypeDef definition
class StatusTypeDef(TypedDict):
DocumentId: NotRequired[str],
DocumentStatus: NotRequired[DocumentStatusType], # (1)
FailureCode: NotRequired[str],
FailureReason: NotRequired[str],BatchPutDocumentResponseFailedDocumentTypeDef#
# BatchPutDocumentResponseFailedDocumentTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchPutDocumentResponseFailedDocumentTypeDef
def get_value() -> BatchPutDocumentResponseFailedDocumentTypeDef:
return {
"Id": ...,
}
# BatchPutDocumentResponseFailedDocumentTypeDef definition
class BatchPutDocumentResponseFailedDocumentTypeDef(TypedDict):
Id: NotRequired[str],
DataSourceId: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],- See ErrorCodeType
CapacityUnitsConfigurationTypeDef#
# CapacityUnitsConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CapacityUnitsConfigurationTypeDef
def get_value() -> CapacityUnitsConfigurationTypeDef:
return {
"StorageCapacityUnits": ...,
}
# CapacityUnitsConfigurationTypeDef definition
class CapacityUnitsConfigurationTypeDef(TypedDict):
StorageCapacityUnits: int,
QueryCapacityUnits: int,ClearQuerySuggestionsRequestTypeDef#
# ClearQuerySuggestionsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ClearQuerySuggestionsRequestTypeDef
def get_value() -> ClearQuerySuggestionsRequestTypeDef:
return {
"IndexId": ...,
}
# ClearQuerySuggestionsRequestTypeDef definition
class ClearQuerySuggestionsRequestTypeDef(TypedDict):
IndexId: str,ExpandConfigurationTypeDef#
# ExpandConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExpandConfigurationTypeDef
def get_value() -> ExpandConfigurationTypeDef:
return {
"MaxResultItemsToExpand": ...,
}
# ExpandConfigurationTypeDef definition
class ExpandConfigurationTypeDef(TypedDict):
MaxResultItemsToExpand: NotRequired[int],
MaxExpandedResultsPerItem: NotRequired[int],SortingConfigurationTypeDef#
# SortingConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SortingConfigurationTypeDef
def get_value() -> SortingConfigurationTypeDef:
return {
"DocumentAttributeKey": ...,
}
# SortingConfigurationTypeDef definition
class SortingConfigurationTypeDef(TypedDict):
DocumentAttributeKey: str,
SortOrder: SortOrderType, # (1)- See SortOrderType
ConfluenceAttachmentToIndexFieldMappingTypeDef#
# ConfluenceAttachmentToIndexFieldMappingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceAttachmentToIndexFieldMappingTypeDef
def get_value() -> ConfluenceAttachmentToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
# ConfluenceAttachmentToIndexFieldMappingTypeDef definition
class ConfluenceAttachmentToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceAttachmentFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],ConfluenceBlogToIndexFieldMappingTypeDef#
# ConfluenceBlogToIndexFieldMappingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceBlogToIndexFieldMappingTypeDef
def get_value() -> ConfluenceBlogToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
# ConfluenceBlogToIndexFieldMappingTypeDef definition
class ConfluenceBlogToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceBlogFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],ProxyConfigurationTypeDef#
# ProxyConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ProxyConfigurationTypeDef
def get_value() -> ProxyConfigurationTypeDef:
return {
"Host": ...,
}
# ProxyConfigurationTypeDef definition
class ProxyConfigurationTypeDef(TypedDict):
Host: str,
Port: int,
Credentials: NotRequired[str],ConfluencePageToIndexFieldMappingTypeDef#
# ConfluencePageToIndexFieldMappingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluencePageToIndexFieldMappingTypeDef
def get_value() -> ConfluencePageToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
# ConfluencePageToIndexFieldMappingTypeDef definition
class ConfluencePageToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluencePageFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],ConfluenceSpaceToIndexFieldMappingTypeDef#
# ConfluenceSpaceToIndexFieldMappingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceSpaceToIndexFieldMappingTypeDef
def get_value() -> ConfluenceSpaceToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
# ConfluenceSpaceToIndexFieldMappingTypeDef definition
class ConfluenceSpaceToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceSpaceFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],ConnectionConfigurationTypeDef#
# ConnectionConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConnectionConfigurationTypeDef
def get_value() -> ConnectionConfigurationTypeDef:
return {
"DatabaseHost": ...,
}
# ConnectionConfigurationTypeDef definition
class ConnectionConfigurationTypeDef(TypedDict):
DatabaseHost: str,
DatabasePort: int,
DatabaseName: str,
TableName: str,
SecretArn: str,ContentSourceConfigurationOutputTypeDef#
# ContentSourceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ContentSourceConfigurationOutputTypeDef
def get_value() -> ContentSourceConfigurationOutputTypeDef:
return {
"DataSourceIds": ...,
}
# ContentSourceConfigurationOutputTypeDef definition
class ContentSourceConfigurationOutputTypeDef(TypedDict):
DataSourceIds: NotRequired[List[str]],
FaqIds: NotRequired[List[str]],
DirectPutContent: NotRequired[bool],ContentSourceConfigurationTypeDef#
# ContentSourceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ContentSourceConfigurationTypeDef
def get_value() -> ContentSourceConfigurationTypeDef:
return {
"DataSourceIds": ...,
}
# ContentSourceConfigurationTypeDef definition
class ContentSourceConfigurationTypeDef(TypedDict):
DataSourceIds: NotRequired[Sequence[str]],
FaqIds: NotRequired[Sequence[str]],
DirectPutContent: NotRequired[bool],CorrectionTypeDef#
# CorrectionTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CorrectionTypeDef
def get_value() -> CorrectionTypeDef:
return {
"BeginOffset": ...,
}
# CorrectionTypeDef definition
class CorrectionTypeDef(TypedDict):
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
Term: NotRequired[str],
CorrectedTerm: NotRequired[str],PrincipalTypeDef#
# PrincipalTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import PrincipalTypeDef
def get_value() -> PrincipalTypeDef:
return {
"Name": ...,
}
# PrincipalTypeDef definition
class PrincipalTypeDef(TypedDict):
Name: str,
Type: PrincipalTypeType, # (1)
Access: ReadAccessTypeType, # (2)
DataSourceId: NotRequired[str],- See PrincipalTypeType
- See ReadAccessTypeType
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,FeaturedDocumentTypeDef#
# FeaturedDocumentTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedDocumentTypeDef
def get_value() -> FeaturedDocumentTypeDef:
return {
"Id": ...,
}
# FeaturedDocumentTypeDef definition
class FeaturedDocumentTypeDef(TypedDict):
Id: NotRequired[str],ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServerSideEncryptionConfigurationTypeDef
def get_value() -> ServerSideEncryptionConfigurationTypeDef:
return {
"KmsKeyId": ...,
}
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
KmsKeyId: NotRequired[str],UserGroupResolutionConfigurationTypeDef#
# UserGroupResolutionConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UserGroupResolutionConfigurationTypeDef
def get_value() -> UserGroupResolutionConfigurationTypeDef:
return {
"UserGroupResolutionMode": ...,
}
# UserGroupResolutionConfigurationTypeDef definition
class UserGroupResolutionConfigurationTypeDef(TypedDict):
UserGroupResolutionMode: UserGroupResolutionModeType, # (1)TemplateConfigurationOutputTypeDef#
# TemplateConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TemplateConfigurationOutputTypeDef
def get_value() -> TemplateConfigurationOutputTypeDef:
return {
"Template": ...,
}
# TemplateConfigurationOutputTypeDef definition
class TemplateConfigurationOutputTypeDef(TypedDict):
Template: NotRequired[Dict[str, Any]],TemplateConfigurationTypeDef#
# TemplateConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TemplateConfigurationTypeDef
def get_value() -> TemplateConfigurationTypeDef:
return {
"Template": ...,
}
# TemplateConfigurationTypeDef definition
class TemplateConfigurationTypeDef(TypedDict):
Template: NotRequired[Mapping[str, Any]],DataSourceGroupTypeDef#
# DataSourceGroupTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceGroupTypeDef
def get_value() -> DataSourceGroupTypeDef:
return {
"GroupId": ...,
}
# DataSourceGroupTypeDef definition
class DataSourceGroupTypeDef(TypedDict):
GroupId: str,
DataSourceId: str,DataSourceSummaryTypeDef#
# DataSourceSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceSummaryTypeDef
def get_value() -> DataSourceSummaryTypeDef:
return {
"Name": ...,
}
# DataSourceSummaryTypeDef definition
class DataSourceSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Type: NotRequired[DataSourceTypeType], # (1)
CreatedAt: NotRequired[datetime.datetime],
UpdatedAt: NotRequired[datetime.datetime],
Status: NotRequired[DataSourceStatusType], # (2)
LanguageCode: NotRequired[str],DataSourceSyncJobMetricsTypeDef#
# DataSourceSyncJobMetricsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceSyncJobMetricsTypeDef
def get_value() -> DataSourceSyncJobMetricsTypeDef:
return {
"DocumentsAdded": ...,
}
# DataSourceSyncJobMetricsTypeDef definition
class DataSourceSyncJobMetricsTypeDef(TypedDict):
DocumentsAdded: NotRequired[str],
DocumentsModified: NotRequired[str],
DocumentsDeleted: NotRequired[str],
DocumentsFailed: NotRequired[str],
DocumentsScanned: NotRequired[str],SqlConfigurationTypeDef#
# SqlConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SqlConfigurationTypeDef
def get_value() -> SqlConfigurationTypeDef:
return {
"QueryIdentifiersEnclosingOption": ...,
}
# SqlConfigurationTypeDef definition
class SqlConfigurationTypeDef(TypedDict):
QueryIdentifiersEnclosingOption: NotRequired[QueryIdentifiersEnclosingOptionType], # (1)DeleteAccessControlConfigurationRequestTypeDef#
# DeleteAccessControlConfigurationRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteAccessControlConfigurationRequestTypeDef
def get_value() -> DeleteAccessControlConfigurationRequestTypeDef:
return {
"IndexId": ...,
}
# DeleteAccessControlConfigurationRequestTypeDef definition
class DeleteAccessControlConfigurationRequestTypeDef(TypedDict):
IndexId: str,
Id: str,DeleteDataSourceRequestTypeDef#
# DeleteDataSourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteDataSourceRequestTypeDef
def get_value() -> DeleteDataSourceRequestTypeDef:
return {
"Id": ...,
}
# DeleteDataSourceRequestTypeDef definition
class DeleteDataSourceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DeleteExperienceRequestTypeDef#
# DeleteExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteExperienceRequestTypeDef
def get_value() -> DeleteExperienceRequestTypeDef:
return {
"Id": ...,
}
# DeleteExperienceRequestTypeDef definition
class DeleteExperienceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DeleteFaqRequestTypeDef#
# DeleteFaqRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteFaqRequestTypeDef
def get_value() -> DeleteFaqRequestTypeDef:
return {
"Id": ...,
}
# DeleteFaqRequestTypeDef definition
class DeleteFaqRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DeleteIndexRequestTypeDef#
# DeleteIndexRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteIndexRequestTypeDef
def get_value() -> DeleteIndexRequestTypeDef:
return {
"Id": ...,
}
# DeleteIndexRequestTypeDef definition
class DeleteIndexRequestTypeDef(TypedDict):
Id: str,DeletePrincipalMappingRequestTypeDef#
# DeletePrincipalMappingRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeletePrincipalMappingRequestTypeDef
def get_value() -> DeletePrincipalMappingRequestTypeDef:
return {
"IndexId": ...,
}
# DeletePrincipalMappingRequestTypeDef definition
class DeletePrincipalMappingRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
DataSourceId: NotRequired[str],
OrderingId: NotRequired[int],DeleteQuerySuggestionsBlockListRequestTypeDef#
# DeleteQuerySuggestionsBlockListRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteQuerySuggestionsBlockListRequestTypeDef
def get_value() -> DeleteQuerySuggestionsBlockListRequestTypeDef:
return {
"IndexId": ...,
}
# DeleteQuerySuggestionsBlockListRequestTypeDef definition
class DeleteQuerySuggestionsBlockListRequestTypeDef(TypedDict):
IndexId: str,
Id: str,DeleteThesaurusRequestTypeDef#
# DeleteThesaurusRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DeleteThesaurusRequestTypeDef
def get_value() -> DeleteThesaurusRequestTypeDef:
return {
"Id": ...,
}
# DeleteThesaurusRequestTypeDef definition
class DeleteThesaurusRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DescribeAccessControlConfigurationRequestTypeDef#
# DescribeAccessControlConfigurationRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeAccessControlConfigurationRequestTypeDef
def get_value() -> DescribeAccessControlConfigurationRequestTypeDef:
return {
"IndexId": ...,
}
# DescribeAccessControlConfigurationRequestTypeDef definition
class DescribeAccessControlConfigurationRequestTypeDef(TypedDict):
IndexId: str,
Id: str,DescribeDataSourceRequestTypeDef#
# DescribeDataSourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeDataSourceRequestTypeDef
def get_value() -> DescribeDataSourceRequestTypeDef:
return {
"Id": ...,
}
# DescribeDataSourceRequestTypeDef definition
class DescribeDataSourceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DescribeExperienceRequestTypeDef#
# DescribeExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeExperienceRequestTypeDef
def get_value() -> DescribeExperienceRequestTypeDef:
return {
"Id": ...,
}
# DescribeExperienceRequestTypeDef definition
class DescribeExperienceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,ExperienceEndpointTypeDef#
# ExperienceEndpointTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExperienceEndpointTypeDef
def get_value() -> ExperienceEndpointTypeDef:
return {
"EndpointType": ...,
}
# ExperienceEndpointTypeDef definition
class ExperienceEndpointTypeDef(TypedDict):
EndpointType: NotRequired[EndpointTypeType], # (1)
Endpoint: NotRequired[str],- See EndpointTypeType
DescribeFaqRequestTypeDef#
# DescribeFaqRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeFaqRequestTypeDef
def get_value() -> DescribeFaqRequestTypeDef:
return {
"Id": ...,
}
# DescribeFaqRequestTypeDef definition
class DescribeFaqRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DescribeFeaturedResultsSetRequestTypeDef#
# DescribeFeaturedResultsSetRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeFeaturedResultsSetRequestTypeDef
def get_value() -> DescribeFeaturedResultsSetRequestTypeDef:
return {
"IndexId": ...,
}
# DescribeFeaturedResultsSetRequestTypeDef definition
class DescribeFeaturedResultsSetRequestTypeDef(TypedDict):
IndexId: str,
FeaturedResultsSetId: str,FeaturedDocumentMissingTypeDef#
# FeaturedDocumentMissingTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedDocumentMissingTypeDef
def get_value() -> FeaturedDocumentMissingTypeDef:
return {
"Id": ...,
}
# FeaturedDocumentMissingTypeDef definition
class FeaturedDocumentMissingTypeDef(TypedDict):
Id: NotRequired[str],FeaturedDocumentWithMetadataTypeDef#
# FeaturedDocumentWithMetadataTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedDocumentWithMetadataTypeDef
def get_value() -> FeaturedDocumentWithMetadataTypeDef:
return {
"Id": ...,
}
# FeaturedDocumentWithMetadataTypeDef definition
class FeaturedDocumentWithMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Title: NotRequired[str],
URI: NotRequired[str],DescribeIndexRequestTypeDef#
# DescribeIndexRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeIndexRequestTypeDef
def get_value() -> DescribeIndexRequestTypeDef:
return {
"Id": ...,
}
# DescribeIndexRequestTypeDef definition
class DescribeIndexRequestTypeDef(TypedDict):
Id: str,DescribePrincipalMappingRequestTypeDef#
# DescribePrincipalMappingRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribePrincipalMappingRequestTypeDef
def get_value() -> DescribePrincipalMappingRequestTypeDef:
return {
"IndexId": ...,
}
# DescribePrincipalMappingRequestTypeDef definition
class DescribePrincipalMappingRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
DataSourceId: NotRequired[str],GroupOrderingIdSummaryTypeDef#
# GroupOrderingIdSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GroupOrderingIdSummaryTypeDef
def get_value() -> GroupOrderingIdSummaryTypeDef:
return {
"Status": ...,
}
# GroupOrderingIdSummaryTypeDef definition
class GroupOrderingIdSummaryTypeDef(TypedDict):
Status: NotRequired[PrincipalMappingStatusType], # (1)
LastUpdatedAt: NotRequired[datetime.datetime],
ReceivedAt: NotRequired[datetime.datetime],
OrderingId: NotRequired[int],
FailureReason: NotRequired[str],DescribeQuerySuggestionsBlockListRequestTypeDef#
# DescribeQuerySuggestionsBlockListRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeQuerySuggestionsBlockListRequestTypeDef
def get_value() -> DescribeQuerySuggestionsBlockListRequestTypeDef:
return {
"IndexId": ...,
}
# DescribeQuerySuggestionsBlockListRequestTypeDef definition
class DescribeQuerySuggestionsBlockListRequestTypeDef(TypedDict):
IndexId: str,
Id: str,DescribeQuerySuggestionsConfigRequestTypeDef#
# DescribeQuerySuggestionsConfigRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeQuerySuggestionsConfigRequestTypeDef
def get_value() -> DescribeQuerySuggestionsConfigRequestTypeDef:
return {
"IndexId": ...,
}
# DescribeQuerySuggestionsConfigRequestTypeDef definition
class DescribeQuerySuggestionsConfigRequestTypeDef(TypedDict):
IndexId: str,DescribeThesaurusRequestTypeDef#
# DescribeThesaurusRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeThesaurusRequestTypeDef
def get_value() -> DescribeThesaurusRequestTypeDef:
return {
"Id": ...,
}
# DescribeThesaurusRequestTypeDef definition
class DescribeThesaurusRequestTypeDef(TypedDict):
Id: str,
IndexId: str,DisassociatePersonasFromEntitiesRequestTypeDef#
# DisassociatePersonasFromEntitiesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DisassociatePersonasFromEntitiesRequestTypeDef
def get_value() -> DisassociatePersonasFromEntitiesRequestTypeDef:
return {
"Id": ...,
}
# DisassociatePersonasFromEntitiesRequestTypeDef definition
class DisassociatePersonasFromEntitiesRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityIds: Sequence[str],DocumentAttributeValueOutputTypeDef#
# DocumentAttributeValueOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeValueOutputTypeDef
def get_value() -> DocumentAttributeValueOutputTypeDef:
return {
"StringValue": ...,
}
# DocumentAttributeValueOutputTypeDef definition
class DocumentAttributeValueOutputTypeDef(TypedDict):
StringValue: NotRequired[str],
StringListValue: NotRequired[List[str]],
LongValue: NotRequired[int],
DateValue: NotRequired[datetime.datetime],RelevanceOutputTypeDef#
# RelevanceOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RelevanceOutputTypeDef
def get_value() -> RelevanceOutputTypeDef:
return {
"Freshness": ...,
}
# RelevanceOutputTypeDef definition
class RelevanceOutputTypeDef(TypedDict):
Freshness: NotRequired[bool],
Importance: NotRequired[int],
Duration: NotRequired[str],
RankOrder: NotRequired[OrderType], # (1)
ValueImportanceMap: NotRequired[Dict[str, int]],- See OrderType
SearchTypeDef#
# SearchTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SearchTypeDef
def get_value() -> SearchTypeDef:
return {
"Facetable": ...,
}
# SearchTypeDef definition
class SearchTypeDef(TypedDict):
Facetable: NotRequired[bool],
Searchable: NotRequired[bool],
Displayable: NotRequired[bool],
Sortable: NotRequired[bool],DocumentsMetadataConfigurationTypeDef#
# DocumentsMetadataConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentsMetadataConfigurationTypeDef
def get_value() -> DocumentsMetadataConfigurationTypeDef:
return {
"S3Prefix": ...,
}
# DocumentsMetadataConfigurationTypeDef definition
class DocumentsMetadataConfigurationTypeDef(TypedDict):
S3Prefix: NotRequired[str],EntityDisplayDataTypeDef#
# EntityDisplayDataTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import EntityDisplayDataTypeDef
def get_value() -> EntityDisplayDataTypeDef:
return {
"UserName": ...,
}
# EntityDisplayDataTypeDef definition
class EntityDisplayDataTypeDef(TypedDict):
UserName: NotRequired[str],
GroupName: NotRequired[str],
IdentifiedUserName: NotRequired[str],
FirstName: NotRequired[str],
LastName: NotRequired[str],UserIdentityConfigurationTypeDef#
# UserIdentityConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UserIdentityConfigurationTypeDef
def get_value() -> UserIdentityConfigurationTypeDef:
return {
"IdentityAttributeName": ...,
}
# UserIdentityConfigurationTypeDef definition
class UserIdentityConfigurationTypeDef(TypedDict):
IdentityAttributeName: NotRequired[str],FacetTypeDef#
# FacetTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FacetTypeDef
def get_value() -> FacetTypeDef:
return {
"DocumentAttributeKey": ...,
}
# FacetTypeDef definition
class FacetTypeDef(TypedDict):
DocumentAttributeKey: NotRequired[str],
Facets: NotRequired[Sequence[Mapping[str, Any]]],
MaxResults: NotRequired[int],FaqStatisticsTypeDef#
# FaqStatisticsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FaqStatisticsTypeDef
def get_value() -> FaqStatisticsTypeDef:
return {
"IndexedQuestionAnswersCount": ...,
}
# FaqStatisticsTypeDef definition
class FaqStatisticsTypeDef(TypedDict):
IndexedQuestionAnswersCount: int,FaqSummaryTypeDef#
# FaqSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FaqSummaryTypeDef
def get_value() -> FaqSummaryTypeDef:
return {
"Id": ...,
}
# FaqSummaryTypeDef definition
class FaqSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[FaqStatusType], # (1)
CreatedAt: NotRequired[datetime.datetime],
UpdatedAt: NotRequired[datetime.datetime],
FileFormat: NotRequired[FaqFileFormatType], # (2)
LanguageCode: NotRequired[str],- See FaqStatusType
- See FaqFileFormatType
FeaturedResultsSetSummaryTypeDef#
# FeaturedResultsSetSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedResultsSetSummaryTypeDef
def get_value() -> FeaturedResultsSetSummaryTypeDef:
return {
"FeaturedResultsSetId": ...,
}
# FeaturedResultsSetSummaryTypeDef definition
class FeaturedResultsSetSummaryTypeDef(TypedDict):
FeaturedResultsSetId: NotRequired[str],
FeaturedResultsSetName: NotRequired[str],
Status: NotRequired[FeaturedResultsSetStatusType], # (1)
LastUpdatedTimestamp: NotRequired[int],
CreationTimestamp: NotRequired[int],GetSnapshotsRequestTypeDef#
# GetSnapshotsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GetSnapshotsRequestTypeDef
def get_value() -> GetSnapshotsRequestTypeDef:
return {
"IndexId": ...,
}
# GetSnapshotsRequestTypeDef definition
class GetSnapshotsRequestTypeDef(TypedDict):
IndexId: str,
Interval: IntervalType, # (1)
MetricType: MetricTypeType, # (2)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],- See IntervalType
- See MetricTypeType
TimeRangeOutputTypeDef#
# TimeRangeOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TimeRangeOutputTypeDef
def get_value() -> TimeRangeOutputTypeDef:
return {
"StartTime": ...,
}
# TimeRangeOutputTypeDef definition
class TimeRangeOutputTypeDef(TypedDict):
StartTime: NotRequired[datetime.datetime],
EndTime: NotRequired[datetime.datetime],GitHubDocumentCrawlPropertiesTypeDef#
# GitHubDocumentCrawlPropertiesTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GitHubDocumentCrawlPropertiesTypeDef
def get_value() -> GitHubDocumentCrawlPropertiesTypeDef:
return {
"CrawlRepositoryDocuments": ...,
}
# GitHubDocumentCrawlPropertiesTypeDef definition
class GitHubDocumentCrawlPropertiesTypeDef(TypedDict):
CrawlRepositoryDocuments: NotRequired[bool],
CrawlIssue: NotRequired[bool],
CrawlIssueComment: NotRequired[bool],
CrawlIssueCommentAttachment: NotRequired[bool],
CrawlPullRequest: NotRequired[bool],
CrawlPullRequestComment: NotRequired[bool],
CrawlPullRequestCommentAttachment: NotRequired[bool],SaaSConfigurationTypeDef#
# SaaSConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SaaSConfigurationTypeDef
def get_value() -> SaaSConfigurationTypeDef:
return {
"OrganizationName": ...,
}
# SaaSConfigurationTypeDef definition
class SaaSConfigurationTypeDef(TypedDict):
OrganizationName: str,
HostUrl: str,MemberGroupTypeDef#
# MemberGroupTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import MemberGroupTypeDef
def get_value() -> MemberGroupTypeDef:
return {
"GroupId": ...,
}
# MemberGroupTypeDef definition
class MemberGroupTypeDef(TypedDict):
GroupId: str,
DataSourceId: NotRequired[str],MemberUserTypeDef#
# MemberUserTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import MemberUserTypeDef
def get_value() -> MemberUserTypeDef:
return {
"UserId": ...,
}
# MemberUserTypeDef definition
class MemberUserTypeDef(TypedDict):
UserId: str,GroupSummaryTypeDef#
# GroupSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GroupSummaryTypeDef
def get_value() -> GroupSummaryTypeDef:
return {
"GroupId": ...,
}
# GroupSummaryTypeDef definition
class GroupSummaryTypeDef(TypedDict):
GroupId: NotRequired[str],
OrderingId: NotRequired[int],HighlightTypeDef#
# HighlightTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import HighlightTypeDef
def get_value() -> HighlightTypeDef:
return {
"BeginOffset": ...,
}
# HighlightTypeDef definition
class HighlightTypeDef(TypedDict):
BeginOffset: int,
EndOffset: int,
TopAnswer: NotRequired[bool],
Type: NotRequired[HighlightTypeType], # (1)IndexConfigurationSummaryTypeDef#
# IndexConfigurationSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import IndexConfigurationSummaryTypeDef
def get_value() -> IndexConfigurationSummaryTypeDef:
return {
"Name": ...,
}
# IndexConfigurationSummaryTypeDef definition
class IndexConfigurationSummaryTypeDef(TypedDict):
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
Status: IndexStatusType, # (2)
Name: NotRequired[str],
Id: NotRequired[str],
Edition: NotRequired[IndexEditionType], # (1)- See IndexEditionType
- See IndexStatusType
TextDocumentStatisticsTypeDef#
# TextDocumentStatisticsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TextDocumentStatisticsTypeDef
def get_value() -> TextDocumentStatisticsTypeDef:
return {
"IndexedTextDocumentsCount": ...,
}
# TextDocumentStatisticsTypeDef definition
class TextDocumentStatisticsTypeDef(TypedDict):
IndexedTextDocumentsCount: int,
IndexedTextBytes: int,JsonTokenTypeConfigurationTypeDef#
# JsonTokenTypeConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import JsonTokenTypeConfigurationTypeDef
def get_value() -> JsonTokenTypeConfigurationTypeDef:
return {
"UserNameAttributeField": ...,
}
# JsonTokenTypeConfigurationTypeDef definition
class JsonTokenTypeConfigurationTypeDef(TypedDict):
UserNameAttributeField: str,
GroupAttributeField: str,JwtTokenTypeConfigurationTypeDef#
# JwtTokenTypeConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import JwtTokenTypeConfigurationTypeDef
def get_value() -> JwtTokenTypeConfigurationTypeDef:
return {
"KeyLocation": ...,
}
# JwtTokenTypeConfigurationTypeDef definition
class JwtTokenTypeConfigurationTypeDef(TypedDict):
KeyLocation: KeyLocationType, # (1)
URL: NotRequired[str],
SecretManagerArn: NotRequired[str],
UserNameAttributeField: NotRequired[str],
GroupAttributeField: NotRequired[str],
Issuer: NotRequired[str],
ClaimRegex: NotRequired[str],- See KeyLocationType
ListAccessControlConfigurationsRequestTypeDef#
# ListAccessControlConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListAccessControlConfigurationsRequestTypeDef
def get_value() -> ListAccessControlConfigurationsRequestTypeDef:
return {
"IndexId": ...,
}
# ListAccessControlConfigurationsRequestTypeDef definition
class ListAccessControlConfigurationsRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListDataSourcesRequestTypeDef#
# ListDataSourcesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListDataSourcesRequestTypeDef
def get_value() -> ListDataSourcesRequestTypeDef:
return {
"IndexId": ...,
}
# ListDataSourcesRequestTypeDef definition
class ListDataSourcesRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListEntityPersonasRequestTypeDef#
# ListEntityPersonasRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListEntityPersonasRequestTypeDef
def get_value() -> ListEntityPersonasRequestTypeDef:
return {
"Id": ...,
}
# ListEntityPersonasRequestTypeDef definition
class ListEntityPersonasRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],PersonasSummaryTypeDef#
# PersonasSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import PersonasSummaryTypeDef
def get_value() -> PersonasSummaryTypeDef:
return {
"EntityId": ...,
}
# PersonasSummaryTypeDef definition
class PersonasSummaryTypeDef(TypedDict):
EntityId: NotRequired[str],
Persona: NotRequired[PersonaType], # (1)
CreatedAt: NotRequired[datetime.datetime],
UpdatedAt: NotRequired[datetime.datetime],- See PersonaType
ListExperienceEntitiesRequestTypeDef#
# ListExperienceEntitiesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListExperienceEntitiesRequestTypeDef
def get_value() -> ListExperienceEntitiesRequestTypeDef:
return {
"Id": ...,
}
# ListExperienceEntitiesRequestTypeDef definition
class ListExperienceEntitiesRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],ListExperiencesRequestTypeDef#
# ListExperiencesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListExperiencesRequestTypeDef
def get_value() -> ListExperiencesRequestTypeDef:
return {
"IndexId": ...,
}
# ListExperiencesRequestTypeDef definition
class ListExperiencesRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListFaqsRequestTypeDef#
# ListFaqsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListFaqsRequestTypeDef
def get_value() -> ListFaqsRequestTypeDef:
return {
"IndexId": ...,
}
# ListFaqsRequestTypeDef definition
class ListFaqsRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListFeaturedResultsSetsRequestTypeDef#
# ListFeaturedResultsSetsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListFeaturedResultsSetsRequestTypeDef
def get_value() -> ListFeaturedResultsSetsRequestTypeDef:
return {
"IndexId": ...,
}
# ListFeaturedResultsSetsRequestTypeDef definition
class ListFeaturedResultsSetsRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListGroupsOlderThanOrderingIdRequestTypeDef#
# ListGroupsOlderThanOrderingIdRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListGroupsOlderThanOrderingIdRequestTypeDef
def get_value() -> ListGroupsOlderThanOrderingIdRequestTypeDef:
return {
"IndexId": ...,
}
# ListGroupsOlderThanOrderingIdRequestTypeDef definition
class ListGroupsOlderThanOrderingIdRequestTypeDef(TypedDict):
IndexId: str,
OrderingId: int,
DataSourceId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListIndicesRequestTypeDef#
# ListIndicesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListIndicesRequestTypeDef
def get_value() -> ListIndicesRequestTypeDef:
return {
"NextToken": ...,
}
# ListIndicesRequestTypeDef definition
class ListIndicesRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ListQuerySuggestionsBlockListsRequestTypeDef#
# ListQuerySuggestionsBlockListsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListQuerySuggestionsBlockListsRequestTypeDef
def get_value() -> ListQuerySuggestionsBlockListsRequestTypeDef:
return {
"IndexId": ...,
}
# ListQuerySuggestionsBlockListsRequestTypeDef definition
class ListQuerySuggestionsBlockListsRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],QuerySuggestionsBlockListSummaryTypeDef#
# QuerySuggestionsBlockListSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QuerySuggestionsBlockListSummaryTypeDef
def get_value() -> QuerySuggestionsBlockListSummaryTypeDef:
return {
"Id": ...,
}
# QuerySuggestionsBlockListSummaryTypeDef definition
class QuerySuggestionsBlockListSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[QuerySuggestionsBlockListStatusType], # (1)
CreatedAt: NotRequired[datetime.datetime],
UpdatedAt: NotRequired[datetime.datetime],
ItemCount: NotRequired[int],ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
ResourceARN: str,ListThesauriRequestTypeDef#
# ListThesauriRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListThesauriRequestTypeDef
def get_value() -> ListThesauriRequestTypeDef:
return {
"IndexId": ...,
}
# ListThesauriRequestTypeDef definition
class ListThesauriRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],ThesaurusSummaryTypeDef#
# ThesaurusSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ThesaurusSummaryTypeDef
def get_value() -> ThesaurusSummaryTypeDef:
return {
"Id": ...,
}
# ThesaurusSummaryTypeDef definition
class ThesaurusSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[ThesaurusStatusType], # (1)
CreatedAt: NotRequired[datetime.datetime],
UpdatedAt: NotRequired[datetime.datetime],SpellCorrectionConfigurationTypeDef#
# SpellCorrectionConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SpellCorrectionConfigurationTypeDef
def get_value() -> SpellCorrectionConfigurationTypeDef:
return {
"IncludeQuerySpellCheckSuggestions": ...,
}
# SpellCorrectionConfigurationTypeDef definition
class SpellCorrectionConfigurationTypeDef(TypedDict):
IncludeQuerySpellCheckSuggestions: bool,ScoreAttributesTypeDef#
# ScoreAttributesTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ScoreAttributesTypeDef
def get_value() -> ScoreAttributesTypeDef:
return {
"ScoreConfidence": ...,
}
# ScoreAttributesTypeDef definition
class ScoreAttributesTypeDef(TypedDict):
ScoreConfidence: NotRequired[ScoreConfidenceType], # (1)WarningTypeDef#
# WarningTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import WarningTypeDef
def get_value() -> WarningTypeDef:
return {
"Message": ...,
}
# WarningTypeDef definition
class WarningTypeDef(TypedDict):
Message: NotRequired[str],
Code: NotRequired[WarningCodeType], # (1)- See WarningCodeType
RelevanceFeedbackTypeDef#
# RelevanceFeedbackTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RelevanceFeedbackTypeDef
def get_value() -> RelevanceFeedbackTypeDef:
return {
"ResultId": ...,
}
# RelevanceFeedbackTypeDef definition
class RelevanceFeedbackTypeDef(TypedDict):
ResultId: str,
RelevanceValue: RelevanceTypeType, # (1)RelevanceTypeDef#
# RelevanceTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RelevanceTypeDef
def get_value() -> RelevanceTypeDef:
return {
"Freshness": ...,
}
# RelevanceTypeDef definition
class RelevanceTypeDef(TypedDict):
Freshness: NotRequired[bool],
Importance: NotRequired[int],
Duration: NotRequired[str],
RankOrder: NotRequired[OrderType], # (1)
ValueImportanceMap: NotRequired[Mapping[str, int]],- See OrderType
SeedUrlConfigurationOutputTypeDef#
# SeedUrlConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SeedUrlConfigurationOutputTypeDef
def get_value() -> SeedUrlConfigurationOutputTypeDef:
return {
"SeedUrls": ...,
}
# SeedUrlConfigurationOutputTypeDef definition
class SeedUrlConfigurationOutputTypeDef(TypedDict):
SeedUrls: List[str],
WebCrawlerMode: NotRequired[WebCrawlerModeType], # (1)SeedUrlConfigurationTypeDef#
# SeedUrlConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SeedUrlConfigurationTypeDef
def get_value() -> SeedUrlConfigurationTypeDef:
return {
"SeedUrls": ...,
}
# SeedUrlConfigurationTypeDef definition
class SeedUrlConfigurationTypeDef(TypedDict):
SeedUrls: Sequence[str],
WebCrawlerMode: NotRequired[WebCrawlerModeType], # (1)SiteMapsConfigurationOutputTypeDef#
# SiteMapsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SiteMapsConfigurationOutputTypeDef
def get_value() -> SiteMapsConfigurationOutputTypeDef:
return {
"SiteMaps": ...,
}
# SiteMapsConfigurationOutputTypeDef definition
class SiteMapsConfigurationOutputTypeDef(TypedDict):
SiteMaps: List[str],SiteMapsConfigurationTypeDef#
# SiteMapsConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SiteMapsConfigurationTypeDef
def get_value() -> SiteMapsConfigurationTypeDef:
return {
"SiteMaps": ...,
}
# SiteMapsConfigurationTypeDef definition
class SiteMapsConfigurationTypeDef(TypedDict):
SiteMaps: Sequence[str],StartDataSourceSyncJobRequestTypeDef#
# StartDataSourceSyncJobRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import StartDataSourceSyncJobRequestTypeDef
def get_value() -> StartDataSourceSyncJobRequestTypeDef:
return {
"Id": ...,
}
# StartDataSourceSyncJobRequestTypeDef definition
class StartDataSourceSyncJobRequestTypeDef(TypedDict):
Id: str,
IndexId: str,StopDataSourceSyncJobRequestTypeDef#
# StopDataSourceSyncJobRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import StopDataSourceSyncJobRequestTypeDef
def get_value() -> StopDataSourceSyncJobRequestTypeDef:
return {
"Id": ...,
}
# StopDataSourceSyncJobRequestTypeDef definition
class StopDataSourceSyncJobRequestTypeDef(TypedDict):
Id: str,
IndexId: str,SuggestionHighlightTypeDef#
# SuggestionHighlightTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SuggestionHighlightTypeDef
def get_value() -> SuggestionHighlightTypeDef:
return {
"BeginOffset": ...,
}
# SuggestionHighlightTypeDef definition
class SuggestionHighlightTypeDef(TypedDict):
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],TableCellTypeDef#
# TableCellTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TableCellTypeDef
def get_value() -> TableCellTypeDef:
return {
"Value": ...,
}
# TableCellTypeDef definition
class TableCellTypeDef(TypedDict):
Value: NotRequired[str],
TopAnswer: NotRequired[bool],
Highlighted: NotRequired[bool],
Header: NotRequired[bool],UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],ColumnConfigurationOutputTypeDef#
# ColumnConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ColumnConfigurationOutputTypeDef
def get_value() -> ColumnConfigurationOutputTypeDef:
return {
"DocumentIdColumnName": ...,
}
# ColumnConfigurationOutputTypeDef definition
class ColumnConfigurationOutputTypeDef(TypedDict):
DocumentIdColumnName: str,
DocumentDataColumnName: str,
ChangeDetectingColumns: List[str],
DocumentTitleColumnName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
ColumnConfigurationTypeDef#
# ColumnConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ColumnConfigurationTypeDef
def get_value() -> ColumnConfigurationTypeDef:
return {
"DocumentIdColumnName": ...,
}
# ColumnConfigurationTypeDef definition
class ColumnConfigurationTypeDef(TypedDict):
DocumentIdColumnName: str,
DocumentDataColumnName: str,
ChangeDetectingColumns: Sequence[str],
DocumentTitleColumnName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
GoogleDriveConfigurationOutputTypeDef#
# GoogleDriveConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GoogleDriveConfigurationOutputTypeDef
def get_value() -> GoogleDriveConfigurationOutputTypeDef:
return {
"SecretArn": ...,
}
# GoogleDriveConfigurationOutputTypeDef definition
class GoogleDriveConfigurationOutputTypeDef(TypedDict):
SecretArn: str,
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
ExcludeMimeTypes: NotRequired[List[str]],
ExcludeUserAccounts: NotRequired[List[str]],
ExcludeSharedDrives: NotRequired[List[str]],- See
List[DataSourceToIndexFieldMappingTypeDef]
GoogleDriveConfigurationTypeDef#
# GoogleDriveConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GoogleDriveConfigurationTypeDef
def get_value() -> GoogleDriveConfigurationTypeDef:
return {
"SecretArn": ...,
}
# GoogleDriveConfigurationTypeDef definition
class GoogleDriveConfigurationTypeDef(TypedDict):
SecretArn: str,
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
ExcludeMimeTypes: NotRequired[Sequence[str]],
ExcludeUserAccounts: NotRequired[Sequence[str]],
ExcludeSharedDrives: NotRequired[Sequence[str]],- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
SalesforceChatterFeedConfigurationOutputTypeDef#
# SalesforceChatterFeedConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceChatterFeedConfigurationOutputTypeDef
def get_value() -> SalesforceChatterFeedConfigurationOutputTypeDef:
return {
"DocumentDataFieldName": ...,
}
# SalesforceChatterFeedConfigurationOutputTypeDef definition
class SalesforceChatterFeedConfigurationOutputTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
IncludeFilterTypes: NotRequired[List[SalesforceChatterFeedIncludeFilterTypeType]], # (2)- See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[SalesforceChatterFeedIncludeFilterTypeType]
SalesforceChatterFeedConfigurationTypeDef#
# SalesforceChatterFeedConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceChatterFeedConfigurationTypeDef
def get_value() -> SalesforceChatterFeedConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
# SalesforceChatterFeedConfigurationTypeDef definition
class SalesforceChatterFeedConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
IncludeFilterTypes: NotRequired[Sequence[SalesforceChatterFeedIncludeFilterTypeType]], # (2)- See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[SalesforceChatterFeedIncludeFilterTypeType]
SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef#
# SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef
def get_value() -> SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef:
return {
"Name": ...,
}
# SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef definition
class SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef(TypedDict):
Name: str,
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef#
# SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
def get_value() -> SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef:
return {
"Name": ...,
}
# SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef definition
class SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
Name: str,
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef#
# SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef
def get_value() -> SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef:
return {
"DocumentDataFieldName": ...,
}
# SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef definition
class SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef#
# SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
def get_value() -> SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
# SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef definition
class SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardObjectAttachmentConfigurationOutputTypeDef#
# SalesforceStandardObjectAttachmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardObjectAttachmentConfigurationOutputTypeDef
def get_value() -> SalesforceStandardObjectAttachmentConfigurationOutputTypeDef:
return {
"DocumentTitleFieldName": ...,
}
# SalesforceStandardObjectAttachmentConfigurationOutputTypeDef definition
class SalesforceStandardObjectAttachmentConfigurationOutputTypeDef(TypedDict):
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardObjectAttachmentConfigurationTypeDef#
# SalesforceStandardObjectAttachmentConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardObjectAttachmentConfigurationTypeDef
def get_value() -> SalesforceStandardObjectAttachmentConfigurationTypeDef:
return {
"DocumentTitleFieldName": ...,
}
# SalesforceStandardObjectAttachmentConfigurationTypeDef definition
class SalesforceStandardObjectAttachmentConfigurationTypeDef(TypedDict):
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardObjectConfigurationOutputTypeDef#
# SalesforceStandardObjectConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardObjectConfigurationOutputTypeDef
def get_value() -> SalesforceStandardObjectConfigurationOutputTypeDef:
return {
"Name": ...,
}
# SalesforceStandardObjectConfigurationOutputTypeDef definition
class SalesforceStandardObjectConfigurationOutputTypeDef(TypedDict):
Name: SalesforceStandardObjectNameType, # (1)
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)- See SalesforceStandardObjectNameType
- See
List[DataSourceToIndexFieldMappingTypeDef]
SalesforceStandardObjectConfigurationTypeDef#
# SalesforceStandardObjectConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceStandardObjectConfigurationTypeDef
def get_value() -> SalesforceStandardObjectConfigurationTypeDef:
return {
"Name": ...,
}
# SalesforceStandardObjectConfigurationTypeDef definition
class SalesforceStandardObjectConfigurationTypeDef(TypedDict):
Name: SalesforceStandardObjectNameType, # (1)
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)- See SalesforceStandardObjectNameType
- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
ServiceNowKnowledgeArticleConfigurationOutputTypeDef#
# ServiceNowKnowledgeArticleConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowKnowledgeArticleConfigurationOutputTypeDef
def get_value() -> ServiceNowKnowledgeArticleConfigurationOutputTypeDef:
return {
"CrawlAttachments": ...,
}
# ServiceNowKnowledgeArticleConfigurationOutputTypeDef definition
class ServiceNowKnowledgeArticleConfigurationOutputTypeDef(TypedDict):
DocumentDataFieldName: str,
CrawlAttachments: NotRequired[bool],
IncludeAttachmentFilePatterns: NotRequired[List[str]],
ExcludeAttachmentFilePatterns: NotRequired[List[str]],
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
FilterQuery: NotRequired[str],- See
List[DataSourceToIndexFieldMappingTypeDef]
ServiceNowKnowledgeArticleConfigurationTypeDef#
# ServiceNowKnowledgeArticleConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowKnowledgeArticleConfigurationTypeDef
def get_value() -> ServiceNowKnowledgeArticleConfigurationTypeDef:
return {
"CrawlAttachments": ...,
}
# ServiceNowKnowledgeArticleConfigurationTypeDef definition
class ServiceNowKnowledgeArticleConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
CrawlAttachments: NotRequired[bool],
IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
FilterQuery: NotRequired[str],- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
ServiceNowServiceCatalogConfigurationOutputTypeDef#
# ServiceNowServiceCatalogConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowServiceCatalogConfigurationOutputTypeDef
def get_value() -> ServiceNowServiceCatalogConfigurationOutputTypeDef:
return {
"CrawlAttachments": ...,
}
# ServiceNowServiceCatalogConfigurationOutputTypeDef definition
class ServiceNowServiceCatalogConfigurationOutputTypeDef(TypedDict):
DocumentDataFieldName: str,
CrawlAttachments: NotRequired[bool],
IncludeAttachmentFilePatterns: NotRequired[List[str]],
ExcludeAttachmentFilePatterns: NotRequired[List[str]],
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
ServiceNowServiceCatalogConfigurationTypeDef#
# ServiceNowServiceCatalogConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowServiceCatalogConfigurationTypeDef
def get_value() -> ServiceNowServiceCatalogConfigurationTypeDef:
return {
"CrawlAttachments": ...,
}
# ServiceNowServiceCatalogConfigurationTypeDef definition
class ServiceNowServiceCatalogConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
CrawlAttachments: NotRequired[bool],
IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
WorkDocsConfigurationOutputTypeDef#
# WorkDocsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import WorkDocsConfigurationOutputTypeDef
def get_value() -> WorkDocsConfigurationOutputTypeDef:
return {
"OrganizationId": ...,
}
# WorkDocsConfigurationOutputTypeDef definition
class WorkDocsConfigurationOutputTypeDef(TypedDict):
OrganizationId: str,
CrawlComments: NotRequired[bool],
UseChangeLog: NotRequired[bool],
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
List[DataSourceToIndexFieldMappingTypeDef]
WorkDocsConfigurationTypeDef#
# WorkDocsConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import WorkDocsConfigurationTypeDef
def get_value() -> WorkDocsConfigurationTypeDef:
return {
"OrganizationId": ...,
}
# WorkDocsConfigurationTypeDef definition
class WorkDocsConfigurationTypeDef(TypedDict):
OrganizationId: str,
CrawlComments: NotRequired[bool],
UseChangeLog: NotRequired[bool],
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
BoxConfigurationOutputTypeDef#
# BoxConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BoxConfigurationOutputTypeDef
def get_value() -> BoxConfigurationOutputTypeDef:
return {
"EnterpriseId": ...,
}
# BoxConfigurationOutputTypeDef definition
class BoxConfigurationOutputTypeDef(TypedDict):
EnterpriseId: str,
SecretArn: str,
UseChangeLog: NotRequired[bool],
CrawlComments: NotRequired[bool],
CrawlTasks: NotRequired[bool],
CrawlWebLinks: NotRequired[bool],
FileFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
TaskFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
CommentFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
WebLinkFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (5)- See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationOutputTypeDef
FsxConfigurationOutputTypeDef#
# FsxConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FsxConfigurationOutputTypeDef
def get_value() -> FsxConfigurationOutputTypeDef:
return {
"FileSystemId": ...,
}
# FsxConfigurationOutputTypeDef definition
class FsxConfigurationOutputTypeDef(TypedDict):
FileSystemId: str,
FileSystemType: FsxFileSystemTypeType, # (1)
VpcConfiguration: DataSourceVpcConfigurationOutputTypeDef, # (2)
SecretArn: NotRequired[str],
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)- See FsxFileSystemTypeType
- See DataSourceVpcConfigurationOutputTypeDef
- See
List[DataSourceToIndexFieldMappingTypeDef]
JiraConfigurationOutputTypeDef#
# JiraConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import JiraConfigurationOutputTypeDef
def get_value() -> JiraConfigurationOutputTypeDef:
return {
"JiraAccountUrl": ...,
}
# JiraConfigurationOutputTypeDef definition
class JiraConfigurationOutputTypeDef(TypedDict):
JiraAccountUrl: str,
SecretArn: str,
UseChangeLog: NotRequired[bool],
Project: NotRequired[List[str]],
IssueType: NotRequired[List[str]],
Status: NotRequired[List[str]],
IssueSubEntityFilter: NotRequired[List[IssueSubEntityType]], # (1)
AttachmentFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
CommentFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
IssueFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
ProjectFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
WorkLogFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (7)- See
List[IssueSubEntityType] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationOutputTypeDef
QuipConfigurationOutputTypeDef#
# QuipConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QuipConfigurationOutputTypeDef
def get_value() -> QuipConfigurationOutputTypeDef:
return {
"Domain": ...,
}
# QuipConfigurationOutputTypeDef definition
class QuipConfigurationOutputTypeDef(TypedDict):
Domain: str,
SecretArn: str,
CrawlFileComments: NotRequired[bool],
CrawlChatRooms: NotRequired[bool],
CrawlAttachments: NotRequired[bool],
FolderIds: NotRequired[List[str]],
ThreadFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
MessageFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
AttachmentFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (1)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (4)- See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationOutputTypeDef
SlackConfigurationOutputTypeDef#
# SlackConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SlackConfigurationOutputTypeDef
def get_value() -> SlackConfigurationOutputTypeDef:
return {
"TeamId": ...,
}
# SlackConfigurationOutputTypeDef definition
class SlackConfigurationOutputTypeDef(TypedDict):
TeamId: str,
SecretArn: str,
SlackEntityList: List[SlackEntityType], # (2)
SinceCrawlDate: str,
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (1)
UseChangeLog: NotRequired[bool],
CrawlBotMessage: NotRequired[bool],
ExcludeArchived: NotRequired[bool],
LookBackPeriod: NotRequired[int],
PrivateChannelFilter: NotRequired[List[str]],
PublicChannelFilter: NotRequired[List[str]],
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)- See DataSourceVpcConfigurationOutputTypeDef
- See
List[SlackEntityType] - See
List[DataSourceToIndexFieldMappingTypeDef]
AlfrescoConfigurationOutputTypeDef#
# AlfrescoConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AlfrescoConfigurationOutputTypeDef
def get_value() -> AlfrescoConfigurationOutputTypeDef:
return {
"SiteUrl": ...,
}
# AlfrescoConfigurationOutputTypeDef definition
class AlfrescoConfigurationOutputTypeDef(TypedDict):
SiteUrl: str,
SiteId: str,
SecretArn: str,
SslCertificateS3Path: S3PathTypeDef, # (1)
CrawlSystemFolders: NotRequired[bool],
CrawlComments: NotRequired[bool],
EntityFilter: NotRequired[List[AlfrescoEntityType]], # (2)
DocumentLibraryFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)
BlogFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)
WikiFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (6)- See S3PathTypeDef
- See
List[AlfrescoEntityType] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationOutputTypeDef
OnPremiseConfigurationTypeDef#
# OnPremiseConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import OnPremiseConfigurationTypeDef
def get_value() -> OnPremiseConfigurationTypeDef:
return {
"HostUrl": ...,
}
# OnPremiseConfigurationTypeDef definition
class OnPremiseConfigurationTypeDef(TypedDict):
HostUrl: str,
OrganizationName: str,
SslCertificateS3Path: S3PathTypeDef, # (1)- See S3PathTypeDef
OneDriveUsersOutputTypeDef#
# OneDriveUsersOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import OneDriveUsersOutputTypeDef
def get_value() -> OneDriveUsersOutputTypeDef:
return {
"OneDriveUserList": ...,
}
# OneDriveUsersOutputTypeDef definition
class OneDriveUsersOutputTypeDef(TypedDict):
OneDriveUserList: NotRequired[List[str]],
OneDriveUserS3Path: NotRequired[S3PathTypeDef], # (1)- See S3PathTypeDef
OneDriveUsersTypeDef#
# OneDriveUsersTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import OneDriveUsersTypeDef
def get_value() -> OneDriveUsersTypeDef:
return {
"OneDriveUserList": ...,
}
# OneDriveUsersTypeDef definition
class OneDriveUsersTypeDef(TypedDict):
OneDriveUserList: NotRequired[Sequence[str]],
OneDriveUserS3Path: NotRequired[S3PathTypeDef], # (1)- See S3PathTypeDef
UpdateQuerySuggestionsBlockListRequestTypeDef#
# UpdateQuerySuggestionsBlockListRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateQuerySuggestionsBlockListRequestTypeDef
def get_value() -> UpdateQuerySuggestionsBlockListRequestTypeDef:
return {
"IndexId": ...,
}
# UpdateQuerySuggestionsBlockListRequestTypeDef definition
class UpdateQuerySuggestionsBlockListRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: NotRequired[str],
Description: NotRequired[str],
SourceS3Path: NotRequired[S3PathTypeDef], # (1)
RoleArn: NotRequired[str],- See S3PathTypeDef
UpdateThesaurusRequestTypeDef#
# UpdateThesaurusRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateThesaurusRequestTypeDef
def get_value() -> UpdateThesaurusRequestTypeDef:
return {
"Id": ...,
}
# UpdateThesaurusRequestTypeDef definition
class UpdateThesaurusRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
Description: NotRequired[str],
RoleArn: NotRequired[str],
SourceS3Path: NotRequired[S3PathTypeDef], # (1)- See S3PathTypeDef
AlfrescoConfigurationTypeDef#
# AlfrescoConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AlfrescoConfigurationTypeDef
def get_value() -> AlfrescoConfigurationTypeDef:
return {
"SiteUrl": ...,
}
# AlfrescoConfigurationTypeDef definition
class AlfrescoConfigurationTypeDef(TypedDict):
SiteUrl: str,
SiteId: str,
SecretArn: str,
SslCertificateS3Path: S3PathTypeDef, # (1)
CrawlSystemFolders: NotRequired[bool],
CrawlComments: NotRequired[bool],
EntityFilter: NotRequired[Sequence[AlfrescoEntityType]], # (2)
DocumentLibraryFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)
BlogFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)
WikiFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (6)- See S3PathTypeDef
- See
Sequence[AlfrescoEntityType] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationTypeDef
BoxConfigurationTypeDef#
# BoxConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BoxConfigurationTypeDef
def get_value() -> BoxConfigurationTypeDef:
return {
"EnterpriseId": ...,
}
# BoxConfigurationTypeDef definition
class BoxConfigurationTypeDef(TypedDict):
EnterpriseId: str,
SecretArn: str,
UseChangeLog: NotRequired[bool],
CrawlComments: NotRequired[bool],
CrawlTasks: NotRequired[bool],
CrawlWebLinks: NotRequired[bool],
FileFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
TaskFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
CommentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
WebLinkFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (5)- See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationTypeDef
FsxConfigurationTypeDef#
# FsxConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FsxConfigurationTypeDef
def get_value() -> FsxConfigurationTypeDef:
return {
"FileSystemId": ...,
}
# FsxConfigurationTypeDef definition
class FsxConfigurationTypeDef(TypedDict):
FileSystemId: str,
FileSystemType: FsxFileSystemTypeType, # (1)
VpcConfiguration: DataSourceVpcConfigurationTypeDef, # (2)
SecretArn: NotRequired[str],
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)- See FsxFileSystemTypeType
- See DataSourceVpcConfigurationTypeDef
- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
JiraConfigurationTypeDef#
# JiraConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import JiraConfigurationTypeDef
def get_value() -> JiraConfigurationTypeDef:
return {
"JiraAccountUrl": ...,
}
# JiraConfigurationTypeDef definition
class JiraConfigurationTypeDef(TypedDict):
JiraAccountUrl: str,
SecretArn: str,
UseChangeLog: NotRequired[bool],
Project: NotRequired[Sequence[str]],
IssueType: NotRequired[Sequence[str]],
Status: NotRequired[Sequence[str]],
IssueSubEntityFilter: NotRequired[Sequence[IssueSubEntityType]], # (1)
AttachmentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
CommentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
IssueFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
ProjectFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
WorkLogFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (7)- See
Sequence[IssueSubEntityType] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationTypeDef
QuipConfigurationTypeDef#
# QuipConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QuipConfigurationTypeDef
def get_value() -> QuipConfigurationTypeDef:
return {
"Domain": ...,
}
# QuipConfigurationTypeDef definition
class QuipConfigurationTypeDef(TypedDict):
Domain: str,
SecretArn: str,
CrawlFileComments: NotRequired[bool],
CrawlChatRooms: NotRequired[bool],
CrawlAttachments: NotRequired[bool],
FolderIds: NotRequired[Sequence[str]],
ThreadFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
MessageFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
AttachmentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (4)- See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See DataSourceVpcConfigurationTypeDef
SlackConfigurationTypeDef#
# SlackConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SlackConfigurationTypeDef
def get_value() -> SlackConfigurationTypeDef:
return {
"TeamId": ...,
}
# SlackConfigurationTypeDef definition
class SlackConfigurationTypeDef(TypedDict):
TeamId: str,
SecretArn: str,
SlackEntityList: Sequence[SlackEntityType], # (2)
SinceCrawlDate: str,
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (1)
UseChangeLog: NotRequired[bool],
CrawlBotMessage: NotRequired[bool],
ExcludeArchived: NotRequired[bool],
LookBackPeriod: NotRequired[int],
PrivateChannelFilter: NotRequired[Sequence[str]],
PublicChannelFilter: NotRequired[Sequence[str]],
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)- See DataSourceVpcConfigurationTypeDef
- See
Sequence[SlackEntityType] - See
Sequence[DataSourceToIndexFieldMappingTypeDef]
AssociateEntitiesToExperienceRequestTypeDef#
# AssociateEntitiesToExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AssociateEntitiesToExperienceRequestTypeDef
def get_value() -> AssociateEntitiesToExperienceRequestTypeDef:
return {
"Id": ...,
}
# AssociateEntitiesToExperienceRequestTypeDef definition
class AssociateEntitiesToExperienceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)- See
Sequence[EntityConfigurationTypeDef]
DisassociateEntitiesFromExperienceRequestTypeDef#
# DisassociateEntitiesFromExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DisassociateEntitiesFromExperienceRequestTypeDef
def get_value() -> DisassociateEntitiesFromExperienceRequestTypeDef:
return {
"Id": ...,
}
# DisassociateEntitiesFromExperienceRequestTypeDef definition
class DisassociateEntitiesFromExperienceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)- See
Sequence[EntityConfigurationTypeDef]
AssociateEntitiesToExperienceResponseTypeDef#
# AssociateEntitiesToExperienceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AssociateEntitiesToExperienceResponseTypeDef
def get_value() -> AssociateEntitiesToExperienceResponseTypeDef:
return {
"FailedEntityList": ...,
}
# AssociateEntitiesToExperienceResponseTypeDef definition
class AssociateEntitiesToExperienceResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[FailedEntityTypeDef] - See ResponseMetadataTypeDef
AssociatePersonasToEntitiesResponseTypeDef#
# AssociatePersonasToEntitiesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AssociatePersonasToEntitiesResponseTypeDef
def get_value() -> AssociatePersonasToEntitiesResponseTypeDef:
return {
"FailedEntityList": ...,
}
# AssociatePersonasToEntitiesResponseTypeDef definition
class AssociatePersonasToEntitiesResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[FailedEntityTypeDef] - See ResponseMetadataTypeDef
CreateAccessControlConfigurationResponseTypeDef#
# CreateAccessControlConfigurationResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateAccessControlConfigurationResponseTypeDef
def get_value() -> CreateAccessControlConfigurationResponseTypeDef:
return {
"Id": ...,
}
# CreateAccessControlConfigurationResponseTypeDef definition
class CreateAccessControlConfigurationResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDataSourceResponseTypeDef#
# CreateDataSourceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateDataSourceResponseTypeDef
def get_value() -> CreateDataSourceResponseTypeDef:
return {
"Id": ...,
}
# CreateDataSourceResponseTypeDef definition
class CreateDataSourceResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateExperienceResponseTypeDef#
# CreateExperienceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateExperienceResponseTypeDef
def get_value() -> CreateExperienceResponseTypeDef:
return {
"Id": ...,
}
# CreateExperienceResponseTypeDef definition
class CreateExperienceResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateFaqResponseTypeDef#
# CreateFaqResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateFaqResponseTypeDef
def get_value() -> CreateFaqResponseTypeDef:
return {
"Id": ...,
}
# CreateFaqResponseTypeDef definition
class CreateFaqResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIndexResponseTypeDef#
# CreateIndexResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateIndexResponseTypeDef
def get_value() -> CreateIndexResponseTypeDef:
return {
"Id": ...,
}
# CreateIndexResponseTypeDef definition
class CreateIndexResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateQuerySuggestionsBlockListResponseTypeDef#
# CreateQuerySuggestionsBlockListResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateQuerySuggestionsBlockListResponseTypeDef
def get_value() -> CreateQuerySuggestionsBlockListResponseTypeDef:
return {
"Id": ...,
}
# CreateQuerySuggestionsBlockListResponseTypeDef definition
class CreateQuerySuggestionsBlockListResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateThesaurusResponseTypeDef#
# CreateThesaurusResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateThesaurusResponseTypeDef
def get_value() -> CreateThesaurusResponseTypeDef:
return {
"Id": ...,
}
# CreateThesaurusResponseTypeDef definition
class CreateThesaurusResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DescribeFaqResponseTypeDef#
# DescribeFaqResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeFaqResponseTypeDef
def get_value() -> DescribeFaqResponseTypeDef:
return {
"Id": ...,
}
# DescribeFaqResponseTypeDef definition
class DescribeFaqResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Description: str,
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
S3Path: S3PathTypeDef, # (1)
Status: FaqStatusType, # (2)
RoleArn: str,
ErrorMessage: str,
FileFormat: FaqFileFormatType, # (3)
LanguageCode: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See S3PathTypeDef
- See FaqStatusType
- See FaqFileFormatType
- See ResponseMetadataTypeDef
DescribeQuerySuggestionsBlockListResponseTypeDef#
# DescribeQuerySuggestionsBlockListResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeQuerySuggestionsBlockListResponseTypeDef
def get_value() -> DescribeQuerySuggestionsBlockListResponseTypeDef:
return {
"IndexId": ...,
}
# DescribeQuerySuggestionsBlockListResponseTypeDef definition
class DescribeQuerySuggestionsBlockListResponseTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: str,
Description: str,
Status: QuerySuggestionsBlockListStatusType, # (1)
ErrorMessage: str,
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
SourceS3Path: S3PathTypeDef, # (2)
ItemCount: int,
FileSizeBytes: int,
RoleArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)DescribeThesaurusResponseTypeDef#
# DescribeThesaurusResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeThesaurusResponseTypeDef
def get_value() -> DescribeThesaurusResponseTypeDef:
return {
"Id": ...,
}
# DescribeThesaurusResponseTypeDef definition
class DescribeThesaurusResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Description: str,
Status: ThesaurusStatusType, # (1)
ErrorMessage: str,
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
RoleArn: str,
SourceS3Path: S3PathTypeDef, # (2)
FileSizeBytes: int,
TermCount: int,
SynonymRuleCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See ThesaurusStatusType
- See S3PathTypeDef
- See ResponseMetadataTypeDef
DisassociateEntitiesFromExperienceResponseTypeDef#
# DisassociateEntitiesFromExperienceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DisassociateEntitiesFromExperienceResponseTypeDef
def get_value() -> DisassociateEntitiesFromExperienceResponseTypeDef:
return {
"FailedEntityList": ...,
}
# DisassociateEntitiesFromExperienceResponseTypeDef definition
class DisassociateEntitiesFromExperienceResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[FailedEntityTypeDef] - See ResponseMetadataTypeDef
DisassociatePersonasFromEntitiesResponseTypeDef#
# DisassociatePersonasFromEntitiesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DisassociatePersonasFromEntitiesResponseTypeDef
def get_value() -> DisassociatePersonasFromEntitiesResponseTypeDef:
return {
"FailedEntityList": ...,
}
# DisassociatePersonasFromEntitiesResponseTypeDef definition
class DisassociatePersonasFromEntitiesResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[FailedEntityTypeDef] - See ResponseMetadataTypeDef
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListAccessControlConfigurationsResponseTypeDef#
# ListAccessControlConfigurationsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListAccessControlConfigurationsResponseTypeDef
def get_value() -> ListAccessControlConfigurationsResponseTypeDef:
return {
"NextToken": ...,
}
# ListAccessControlConfigurationsResponseTypeDef definition
class ListAccessControlConfigurationsResponseTypeDef(TypedDict):
AccessControlConfigurations: List[AccessControlConfigurationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[AccessControlConfigurationSummaryTypeDef] - See ResponseMetadataTypeDef
StartDataSourceSyncJobResponseTypeDef#
# StartDataSourceSyncJobResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import StartDataSourceSyncJobResponseTypeDef
def get_value() -> StartDataSourceSyncJobResponseTypeDef:
return {
"ExecutionId": ...,
}
# StartDataSourceSyncJobResponseTypeDef definition
class StartDataSourceSyncJobResponseTypeDef(TypedDict):
ExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AssociatePersonasToEntitiesRequestTypeDef#
# AssociatePersonasToEntitiesRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AssociatePersonasToEntitiesRequestTypeDef
def get_value() -> AssociatePersonasToEntitiesRequestTypeDef:
return {
"Id": ...,
}
# AssociatePersonasToEntitiesRequestTypeDef definition
class AssociatePersonasToEntitiesRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Personas: Sequence[EntityPersonaConfigurationTypeDef], # (1)- See
Sequence[EntityPersonaConfigurationTypeDef]
AttributeSuggestionsDescribeConfigTypeDef#
# AttributeSuggestionsDescribeConfigTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AttributeSuggestionsDescribeConfigTypeDef
def get_value() -> AttributeSuggestionsDescribeConfigTypeDef:
return {
"SuggestableConfigList": ...,
}
# AttributeSuggestionsDescribeConfigTypeDef definition
class AttributeSuggestionsDescribeConfigTypeDef(TypedDict):
SuggestableConfigList: NotRequired[List[SuggestableConfigTypeDef]], # (1)
AttributeSuggestionsMode: NotRequired[AttributeSuggestionsModeType], # (2)- See
List[SuggestableConfigTypeDef] - See AttributeSuggestionsModeType
AttributeSuggestionsUpdateConfigTypeDef#
# AttributeSuggestionsUpdateConfigTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AttributeSuggestionsUpdateConfigTypeDef
def get_value() -> AttributeSuggestionsUpdateConfigTypeDef:
return {
"SuggestableConfigList": ...,
}
# AttributeSuggestionsUpdateConfigTypeDef definition
class AttributeSuggestionsUpdateConfigTypeDef(TypedDict):
SuggestableConfigList: NotRequired[Sequence[SuggestableConfigTypeDef]], # (1)
AttributeSuggestionsMode: NotRequired[AttributeSuggestionsModeType], # (2)- See
Sequence[SuggestableConfigTypeDef] - See AttributeSuggestionsModeType
AuthenticationConfigurationOutputTypeDef#
# AuthenticationConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AuthenticationConfigurationOutputTypeDef
def get_value() -> AuthenticationConfigurationOutputTypeDef:
return {
"BasicAuthentication": ...,
}
# AuthenticationConfigurationOutputTypeDef definition
class AuthenticationConfigurationOutputTypeDef(TypedDict):
BasicAuthentication: NotRequired[List[BasicAuthenticationConfigurationTypeDef]], # (1)- See
List[BasicAuthenticationConfigurationTypeDef]
AuthenticationConfigurationTypeDef#
# AuthenticationConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AuthenticationConfigurationTypeDef
def get_value() -> AuthenticationConfigurationTypeDef:
return {
"BasicAuthentication": ...,
}
# AuthenticationConfigurationTypeDef definition
class AuthenticationConfigurationTypeDef(TypedDict):
BasicAuthentication: NotRequired[Sequence[BasicAuthenticationConfigurationTypeDef]], # (1)- See
Sequence[BasicAuthenticationConfigurationTypeDef]
BatchDeleteDocumentRequestTypeDef#
# BatchDeleteDocumentRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteDocumentRequestTypeDef
def get_value() -> BatchDeleteDocumentRequestTypeDef:
return {
"IndexId": ...,
}
# BatchDeleteDocumentRequestTypeDef definition
class BatchDeleteDocumentRequestTypeDef(TypedDict):
IndexId: str,
DocumentIdList: Sequence[str],
DataSourceSyncJobMetricTarget: NotRequired[DataSourceSyncJobMetricTargetTypeDef], # (1)BatchDeleteDocumentResponseTypeDef#
# BatchDeleteDocumentResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteDocumentResponseTypeDef
def get_value() -> BatchDeleteDocumentResponseTypeDef:
return {
"FailedDocuments": ...,
}
# BatchDeleteDocumentResponseTypeDef definition
class BatchDeleteDocumentResponseTypeDef(TypedDict):
FailedDocuments: List[BatchDeleteDocumentResponseFailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchDeleteDocumentResponseFailedDocumentTypeDef] - See ResponseMetadataTypeDef
BatchDeleteFeaturedResultsSetResponseTypeDef#
# BatchDeleteFeaturedResultsSetResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetResponseTypeDef
def get_value() -> BatchDeleteFeaturedResultsSetResponseTypeDef:
return {
"Errors": ...,
}
# BatchDeleteFeaturedResultsSetResponseTypeDef definition
class BatchDeleteFeaturedResultsSetResponseTypeDef(TypedDict):
Errors: List[BatchDeleteFeaturedResultsSetErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchDeleteFeaturedResultsSetErrorTypeDef] - See ResponseMetadataTypeDef
BatchGetDocumentStatusResponseTypeDef#
# BatchGetDocumentStatusResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchGetDocumentStatusResponseTypeDef
def get_value() -> BatchGetDocumentStatusResponseTypeDef:
return {
"Errors": ...,
}
# BatchGetDocumentStatusResponseTypeDef definition
class BatchGetDocumentStatusResponseTypeDef(TypedDict):
Errors: List[BatchGetDocumentStatusResponseErrorTypeDef], # (1)
DocumentStatusList: List[StatusTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[BatchGetDocumentStatusResponseErrorTypeDef] - See
List[StatusTypeDef] - See ResponseMetadataTypeDef
BatchPutDocumentResponseTypeDef#
# BatchPutDocumentResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchPutDocumentResponseTypeDef
def get_value() -> BatchPutDocumentResponseTypeDef:
return {
"FailedDocuments": ...,
}
# BatchPutDocumentResponseTypeDef definition
class BatchPutDocumentResponseTypeDef(TypedDict):
FailedDocuments: List[BatchPutDocumentResponseFailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[BatchPutDocumentResponseFailedDocumentTypeDef] - See ResponseMetadataTypeDef
ClickFeedbackTypeDef#
# ClickFeedbackTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ClickFeedbackTypeDef
def get_value() -> ClickFeedbackTypeDef:
return {
"ResultId": ...,
}
# ClickFeedbackTypeDef definition
class ClickFeedbackTypeDef(TypedDict):
ResultId: str,
ClickTime: TimestampTypeDef,DocumentAttributeValueTypeDef#
# DocumentAttributeValueTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeValueTypeDef
def get_value() -> DocumentAttributeValueTypeDef:
return {
"StringValue": ...,
}
# DocumentAttributeValueTypeDef definition
class DocumentAttributeValueTypeDef(TypedDict):
StringValue: NotRequired[str],
StringListValue: NotRequired[Sequence[str]],
LongValue: NotRequired[int],
DateValue: NotRequired[TimestampTypeDef],TimeRangeTypeDef#
# TimeRangeTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TimeRangeTypeDef
def get_value() -> TimeRangeTypeDef:
return {
"StartTime": ...,
}
# TimeRangeTypeDef definition
class TimeRangeTypeDef(TypedDict):
StartTime: NotRequired[TimestampTypeDef],
EndTime: NotRequired[TimestampTypeDef],CollapseConfigurationTypeDef#
# CollapseConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CollapseConfigurationTypeDef
def get_value() -> CollapseConfigurationTypeDef:
return {
"DocumentAttributeKey": ...,
}
# CollapseConfigurationTypeDef definition
class CollapseConfigurationTypeDef(TypedDict):
DocumentAttributeKey: str,
SortingConfigurations: NotRequired[Sequence[SortingConfigurationTypeDef]], # (1)
MissingAttributeKeyStrategy: NotRequired[MissingAttributeKeyStrategyType], # (2)
Expand: NotRequired[bool],
ExpandConfiguration: NotRequired[ExpandConfigurationTypeDef], # (3)- See
Sequence[SortingConfigurationTypeDef] - See MissingAttributeKeyStrategyType
- See ExpandConfigurationTypeDef
ConfluenceAttachmentConfigurationOutputTypeDef#
# ConfluenceAttachmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceAttachmentConfigurationOutputTypeDef
def get_value() -> ConfluenceAttachmentConfigurationOutputTypeDef:
return {
"CrawlAttachments": ...,
}
# ConfluenceAttachmentConfigurationOutputTypeDef definition
class ConfluenceAttachmentConfigurationOutputTypeDef(TypedDict):
CrawlAttachments: NotRequired[bool],
AttachmentFieldMappings: NotRequired[List[ConfluenceAttachmentToIndexFieldMappingTypeDef]], # (1)- See
List[ConfluenceAttachmentToIndexFieldMappingTypeDef]
ConfluenceAttachmentConfigurationTypeDef#
# ConfluenceAttachmentConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceAttachmentConfigurationTypeDef
def get_value() -> ConfluenceAttachmentConfigurationTypeDef:
return {
"CrawlAttachments": ...,
}
# ConfluenceAttachmentConfigurationTypeDef definition
class ConfluenceAttachmentConfigurationTypeDef(TypedDict):
CrawlAttachments: NotRequired[bool],
AttachmentFieldMappings: NotRequired[Sequence[ConfluenceAttachmentToIndexFieldMappingTypeDef]], # (1)- See
Sequence[ConfluenceAttachmentToIndexFieldMappingTypeDef]
ConfluenceBlogConfigurationOutputTypeDef#
# ConfluenceBlogConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceBlogConfigurationOutputTypeDef
def get_value() -> ConfluenceBlogConfigurationOutputTypeDef:
return {
"BlogFieldMappings": ...,
}
# ConfluenceBlogConfigurationOutputTypeDef definition
class ConfluenceBlogConfigurationOutputTypeDef(TypedDict):
BlogFieldMappings: NotRequired[List[ConfluenceBlogToIndexFieldMappingTypeDef]], # (1)- See
List[ConfluenceBlogToIndexFieldMappingTypeDef]
ConfluenceBlogConfigurationTypeDef#
# ConfluenceBlogConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceBlogConfigurationTypeDef
def get_value() -> ConfluenceBlogConfigurationTypeDef:
return {
"BlogFieldMappings": ...,
}
# ConfluenceBlogConfigurationTypeDef definition
class ConfluenceBlogConfigurationTypeDef(TypedDict):
BlogFieldMappings: NotRequired[Sequence[ConfluenceBlogToIndexFieldMappingTypeDef]], # (1)- See
Sequence[ConfluenceBlogToIndexFieldMappingTypeDef]
SharePointConfigurationOutputTypeDef#
# SharePointConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SharePointConfigurationOutputTypeDef
def get_value() -> SharePointConfigurationOutputTypeDef:
return {
"SharePointVersion": ...,
}
# SharePointConfigurationOutputTypeDef definition
class SharePointConfigurationOutputTypeDef(TypedDict):
SharePointVersion: SharePointVersionType, # (1)
Urls: List[str],
SecretArn: str,
CrawlAttachments: NotRequired[bool],
UseChangeLog: NotRequired[bool],
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (2)
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (3)
DocumentTitleFieldName: NotRequired[str],
DisableLocalGroups: NotRequired[bool],
SslCertificateS3Path: NotRequired[S3PathTypeDef], # (4)
AuthenticationType: NotRequired[SharePointOnlineAuthenticationTypeType], # (5)
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (6)- See SharePointVersionType
- See DataSourceVpcConfigurationOutputTypeDef
- See
List[DataSourceToIndexFieldMappingTypeDef] - See S3PathTypeDef
- See SharePointOnlineAuthenticationTypeType
- See ProxyConfigurationTypeDef
SharePointConfigurationTypeDef#
# SharePointConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SharePointConfigurationTypeDef
def get_value() -> SharePointConfigurationTypeDef:
return {
"SharePointVersion": ...,
}
# SharePointConfigurationTypeDef definition
class SharePointConfigurationTypeDef(TypedDict):
SharePointVersion: SharePointVersionType, # (1)
Urls: Sequence[str],
SecretArn: str,
CrawlAttachments: NotRequired[bool],
UseChangeLog: NotRequired[bool],
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (2)
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (3)
DocumentTitleFieldName: NotRequired[str],
DisableLocalGroups: NotRequired[bool],
SslCertificateS3Path: NotRequired[S3PathTypeDef], # (4)
AuthenticationType: NotRequired[SharePointOnlineAuthenticationTypeType], # (5)
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (6)- See SharePointVersionType
- See DataSourceVpcConfigurationTypeDef
- See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See S3PathTypeDef
- See SharePointOnlineAuthenticationTypeType
- See ProxyConfigurationTypeDef
ConfluencePageConfigurationOutputTypeDef#
# ConfluencePageConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluencePageConfigurationOutputTypeDef
def get_value() -> ConfluencePageConfigurationOutputTypeDef:
return {
"PageFieldMappings": ...,
}
# ConfluencePageConfigurationOutputTypeDef definition
class ConfluencePageConfigurationOutputTypeDef(TypedDict):
PageFieldMappings: NotRequired[List[ConfluencePageToIndexFieldMappingTypeDef]], # (1)- See
List[ConfluencePageToIndexFieldMappingTypeDef]
ConfluencePageConfigurationTypeDef#
# ConfluencePageConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluencePageConfigurationTypeDef
def get_value() -> ConfluencePageConfigurationTypeDef:
return {
"PageFieldMappings": ...,
}
# ConfluencePageConfigurationTypeDef definition
class ConfluencePageConfigurationTypeDef(TypedDict):
PageFieldMappings: NotRequired[Sequence[ConfluencePageToIndexFieldMappingTypeDef]], # (1)- See
Sequence[ConfluencePageToIndexFieldMappingTypeDef]
ConfluenceSpaceConfigurationOutputTypeDef#
# ConfluenceSpaceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceSpaceConfigurationOutputTypeDef
def get_value() -> ConfluenceSpaceConfigurationOutputTypeDef:
return {
"CrawlPersonalSpaces": ...,
}
# ConfluenceSpaceConfigurationOutputTypeDef definition
class ConfluenceSpaceConfigurationOutputTypeDef(TypedDict):
CrawlPersonalSpaces: NotRequired[bool],
CrawlArchivedSpaces: NotRequired[bool],
IncludeSpaces: NotRequired[List[str]],
ExcludeSpaces: NotRequired[List[str]],
SpaceFieldMappings: NotRequired[List[ConfluenceSpaceToIndexFieldMappingTypeDef]], # (1)- See
List[ConfluenceSpaceToIndexFieldMappingTypeDef]
ConfluenceSpaceConfigurationTypeDef#
# ConfluenceSpaceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceSpaceConfigurationTypeDef
def get_value() -> ConfluenceSpaceConfigurationTypeDef:
return {
"CrawlPersonalSpaces": ...,
}
# ConfluenceSpaceConfigurationTypeDef definition
class ConfluenceSpaceConfigurationTypeDef(TypedDict):
CrawlPersonalSpaces: NotRequired[bool],
CrawlArchivedSpaces: NotRequired[bool],
IncludeSpaces: NotRequired[Sequence[str]],
ExcludeSpaces: NotRequired[Sequence[str]],
SpaceFieldMappings: NotRequired[Sequence[ConfluenceSpaceToIndexFieldMappingTypeDef]], # (1)- See
Sequence[ConfluenceSpaceToIndexFieldMappingTypeDef]
SpellCorrectedQueryTypeDef#
# SpellCorrectedQueryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SpellCorrectedQueryTypeDef
def get_value() -> SpellCorrectedQueryTypeDef:
return {
"SuggestedQueryText": ...,
}
# SpellCorrectedQueryTypeDef definition
class SpellCorrectedQueryTypeDef(TypedDict):
SuggestedQueryText: NotRequired[str],
Corrections: NotRequired[List[CorrectionTypeDef]], # (1)- See
List[CorrectionTypeDef]
HierarchicalPrincipalOutputTypeDef#
# HierarchicalPrincipalOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import HierarchicalPrincipalOutputTypeDef
def get_value() -> HierarchicalPrincipalOutputTypeDef:
return {
"PrincipalList": ...,
}
# HierarchicalPrincipalOutputTypeDef definition
class HierarchicalPrincipalOutputTypeDef(TypedDict):
PrincipalList: List[PrincipalTypeDef], # (1)- See
List[PrincipalTypeDef]
HierarchicalPrincipalTypeDef#
# HierarchicalPrincipalTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import HierarchicalPrincipalTypeDef
def get_value() -> HierarchicalPrincipalTypeDef:
return {
"PrincipalList": ...,
}
# HierarchicalPrincipalTypeDef definition
class HierarchicalPrincipalTypeDef(TypedDict):
PrincipalList: Sequence[PrincipalTypeDef], # (1)- See
Sequence[PrincipalTypeDef]
CreateFaqRequestTypeDef#
# CreateFaqRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateFaqRequestTypeDef
def get_value() -> CreateFaqRequestTypeDef:
return {
"IndexId": ...,
}
# CreateFaqRequestTypeDef definition
class CreateFaqRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
S3Path: S3PathTypeDef, # (1)
RoleArn: str,
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
FileFormat: NotRequired[FaqFileFormatType], # (3)
ClientToken: NotRequired[str],
LanguageCode: NotRequired[str],- See S3PathTypeDef
- See
Sequence[TagTypeDef] - See FaqFileFormatType
CreateQuerySuggestionsBlockListRequestTypeDef#
# CreateQuerySuggestionsBlockListRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateQuerySuggestionsBlockListRequestTypeDef
def get_value() -> CreateQuerySuggestionsBlockListRequestTypeDef:
return {
"IndexId": ...,
}
# CreateQuerySuggestionsBlockListRequestTypeDef definition
class CreateQuerySuggestionsBlockListRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
SourceS3Path: S3PathTypeDef, # (1)
RoleArn: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)- See S3PathTypeDef
- See
Sequence[TagTypeDef]
CreateThesaurusRequestTypeDef#
# CreateThesaurusRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateThesaurusRequestTypeDef
def get_value() -> CreateThesaurusRequestTypeDef:
return {
"IndexId": ...,
}
# CreateThesaurusRequestTypeDef definition
class CreateThesaurusRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
RoleArn: str,
SourceS3Path: S3PathTypeDef, # (1)
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ClientToken: NotRequired[str],- See S3PathTypeDef
- See
Sequence[TagTypeDef]
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[TagTypeDef] - See ResponseMetadataTypeDef
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"ResourceARN": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)- See
Sequence[TagTypeDef]
CreateFeaturedResultsSetRequestTypeDef#
# CreateFeaturedResultsSetRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateFeaturedResultsSetRequestTypeDef
def get_value() -> CreateFeaturedResultsSetRequestTypeDef:
return {
"IndexId": ...,
}
# CreateFeaturedResultsSetRequestTypeDef definition
class CreateFeaturedResultsSetRequestTypeDef(TypedDict):
IndexId: str,
FeaturedResultsSetName: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Status: NotRequired[FeaturedResultsSetStatusType], # (1)
QueryTexts: NotRequired[Sequence[str]],
FeaturedDocuments: NotRequired[Sequence[FeaturedDocumentTypeDef]], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)- See FeaturedResultsSetStatusType
- See
Sequence[FeaturedDocumentTypeDef] - See
Sequence[TagTypeDef]
FeaturedResultsSetTypeDef#
# FeaturedResultsSetTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedResultsSetTypeDef
def get_value() -> FeaturedResultsSetTypeDef:
return {
"FeaturedResultsSetId": ...,
}
# FeaturedResultsSetTypeDef definition
class FeaturedResultsSetTypeDef(TypedDict):
FeaturedResultsSetId: NotRequired[str],
FeaturedResultsSetName: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[FeaturedResultsSetStatusType], # (1)
QueryTexts: NotRequired[List[str]],
FeaturedDocuments: NotRequired[List[FeaturedDocumentTypeDef]], # (2)
LastUpdatedTimestamp: NotRequired[int],
CreationTimestamp: NotRequired[int],- See FeaturedResultsSetStatusType
- See
List[FeaturedDocumentTypeDef]
UpdateFeaturedResultsSetRequestTypeDef#
# UpdateFeaturedResultsSetRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateFeaturedResultsSetRequestTypeDef
def get_value() -> UpdateFeaturedResultsSetRequestTypeDef:
return {
"IndexId": ...,
}
# UpdateFeaturedResultsSetRequestTypeDef definition
class UpdateFeaturedResultsSetRequestTypeDef(TypedDict):
IndexId: str,
FeaturedResultsSetId: str,
FeaturedResultsSetName: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[FeaturedResultsSetStatusType], # (1)
QueryTexts: NotRequired[Sequence[str]],
FeaturedDocuments: NotRequired[Sequence[FeaturedDocumentTypeDef]], # (2)- See FeaturedResultsSetStatusType
- See
Sequence[FeaturedDocumentTypeDef]
UserContextTypeDef#
# UserContextTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UserContextTypeDef
def get_value() -> UserContextTypeDef:
return {
"Token": ...,
}
# UserContextTypeDef definition
class UserContextTypeDef(TypedDict):
Token: NotRequired[str],
UserId: NotRequired[str],
Groups: NotRequired[Sequence[str]],
DataSourceGroups: NotRequired[Sequence[DataSourceGroupTypeDef]], # (1)- See
Sequence[DataSourceGroupTypeDef]
ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListDataSourcesResponseTypeDef
def get_value() -> ListDataSourcesResponseTypeDef:
return {
"SummaryItems": ...,
}
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
SummaryItems: List[DataSourceSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[DataSourceSummaryTypeDef] - See ResponseMetadataTypeDef
DataSourceSyncJobTypeDef#
# DataSourceSyncJobTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceSyncJobTypeDef
def get_value() -> DataSourceSyncJobTypeDef:
return {
"ExecutionId": ...,
}
# DataSourceSyncJobTypeDef definition
class DataSourceSyncJobTypeDef(TypedDict):
ExecutionId: NotRequired[str],
StartTime: NotRequired[datetime.datetime],
EndTime: NotRequired[datetime.datetime],
Status: NotRequired[DataSourceSyncJobStatusType], # (1)
ErrorMessage: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (2)
DataSourceErrorCode: NotRequired[str],
Metrics: NotRequired[DataSourceSyncJobMetricsTypeDef], # (3)ExperiencesSummaryTypeDef#
# ExperiencesSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExperiencesSummaryTypeDef
def get_value() -> ExperiencesSummaryTypeDef:
return {
"Name": ...,
}
# ExperiencesSummaryTypeDef definition
class ExperiencesSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
CreatedAt: NotRequired[datetime.datetime],
Status: NotRequired[ExperienceStatusType], # (1)
Endpoints: NotRequired[List[ExperienceEndpointTypeDef]], # (2)- See ExperienceStatusType
- See
List[ExperienceEndpointTypeDef]
DescribeFeaturedResultsSetResponseTypeDef#
# DescribeFeaturedResultsSetResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeFeaturedResultsSetResponseTypeDef
def get_value() -> DescribeFeaturedResultsSetResponseTypeDef:
return {
"FeaturedResultsSetId": ...,
}
# DescribeFeaturedResultsSetResponseTypeDef definition
class DescribeFeaturedResultsSetResponseTypeDef(TypedDict):
FeaturedResultsSetId: str,
FeaturedResultsSetName: str,
Description: str,
Status: FeaturedResultsSetStatusType, # (1)
QueryTexts: List[str],
FeaturedDocumentsWithMetadata: List[FeaturedDocumentWithMetadataTypeDef], # (2)
FeaturedDocumentsMissing: List[FeaturedDocumentMissingTypeDef], # (3)
LastUpdatedTimestamp: int,
CreationTimestamp: int,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See FeaturedResultsSetStatusType
- See
List[FeaturedDocumentWithMetadataTypeDef] - See
List[FeaturedDocumentMissingTypeDef] - See ResponseMetadataTypeDef
DescribePrincipalMappingResponseTypeDef#
# DescribePrincipalMappingResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribePrincipalMappingResponseTypeDef
def get_value() -> DescribePrincipalMappingResponseTypeDef:
return {
"IndexId": ...,
}
# DescribePrincipalMappingResponseTypeDef definition
class DescribePrincipalMappingResponseTypeDef(TypedDict):
IndexId: str,
DataSourceId: str,
GroupId: str,
GroupOrderingIdSummaries: List[GroupOrderingIdSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[GroupOrderingIdSummaryTypeDef] - See ResponseMetadataTypeDef
DocumentAttributeConditionOutputTypeDef#
# DocumentAttributeConditionOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeConditionOutputTypeDef
def get_value() -> DocumentAttributeConditionOutputTypeDef:
return {
"ConditionDocumentAttributeKey": ...,
}
# DocumentAttributeConditionOutputTypeDef definition
class DocumentAttributeConditionOutputTypeDef(TypedDict):
ConditionDocumentAttributeKey: str,
Operator: ConditionOperatorType, # (1)
ConditionOnValue: NotRequired[DocumentAttributeValueOutputTypeDef], # (2)DocumentAttributeOutputTypeDef#
# DocumentAttributeOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeOutputTypeDef
def get_value() -> DocumentAttributeOutputTypeDef:
return {
"Key": ...,
}
# DocumentAttributeOutputTypeDef definition
class DocumentAttributeOutputTypeDef(TypedDict):
Key: str,
Value: DocumentAttributeValueOutputTypeDef, # (1)DocumentAttributeTargetOutputTypeDef#
# DocumentAttributeTargetOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeTargetOutputTypeDef
def get_value() -> DocumentAttributeTargetOutputTypeDef:
return {
"TargetDocumentAttributeKey": ...,
}
# DocumentAttributeTargetOutputTypeDef definition
class DocumentAttributeTargetOutputTypeDef(TypedDict):
TargetDocumentAttributeKey: NotRequired[str],
TargetDocumentAttributeValueDeletion: NotRequired[bool],
TargetDocumentAttributeValue: NotRequired[DocumentAttributeValueOutputTypeDef], # (1)DocumentAttributeValueCountPairTypeDef#
# DocumentAttributeValueCountPairTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeValueCountPairTypeDef
def get_value() -> DocumentAttributeValueCountPairTypeDef:
return {
"DocumentAttributeValue": ...,
}
# DocumentAttributeValueCountPairTypeDef definition
class DocumentAttributeValueCountPairTypeDef(TypedDict):
DocumentAttributeValue: NotRequired[DocumentAttributeValueOutputTypeDef], # (1)
Count: NotRequired[int],
FacetResults: NotRequired[List[Dict[str, Any]]],DocumentMetadataConfigurationOutputTypeDef#
# DocumentMetadataConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentMetadataConfigurationOutputTypeDef
def get_value() -> DocumentMetadataConfigurationOutputTypeDef:
return {
"Name": ...,
}
# DocumentMetadataConfigurationOutputTypeDef definition
class DocumentMetadataConfigurationOutputTypeDef(TypedDict):
Name: str,
Type: DocumentAttributeValueTypeType, # (1)
Relevance: NotRequired[RelevanceOutputTypeDef], # (2)
Search: NotRequired[SearchTypeDef], # (3)S3DataSourceConfigurationOutputTypeDef#
# S3DataSourceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import S3DataSourceConfigurationOutputTypeDef
def get_value() -> S3DataSourceConfigurationOutputTypeDef:
return {
"BucketName": ...,
}
# S3DataSourceConfigurationOutputTypeDef definition
class S3DataSourceConfigurationOutputTypeDef(TypedDict):
BucketName: str,
InclusionPrefixes: NotRequired[List[str]],
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
DocumentsMetadataConfiguration: NotRequired[DocumentsMetadataConfigurationTypeDef], # (1)
AccessControlListConfiguration: NotRequired[AccessControlListConfigurationTypeDef], # (2)S3DataSourceConfigurationTypeDef#
# S3DataSourceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import S3DataSourceConfigurationTypeDef
def get_value() -> S3DataSourceConfigurationTypeDef:
return {
"BucketName": ...,
}
# S3DataSourceConfigurationTypeDef definition
class S3DataSourceConfigurationTypeDef(TypedDict):
BucketName: str,
InclusionPrefixes: NotRequired[Sequence[str]],
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
DocumentsMetadataConfiguration: NotRequired[DocumentsMetadataConfigurationTypeDef], # (1)
AccessControlListConfiguration: NotRequired[AccessControlListConfigurationTypeDef], # (2)ExperienceEntitiesSummaryTypeDef#
# ExperienceEntitiesSummaryTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExperienceEntitiesSummaryTypeDef
def get_value() -> ExperienceEntitiesSummaryTypeDef:
return {
"EntityId": ...,
}
# ExperienceEntitiesSummaryTypeDef definition
class ExperienceEntitiesSummaryTypeDef(TypedDict):
EntityId: NotRequired[str],
EntityType: NotRequired[EntityTypeType], # (1)
DisplayData: NotRequired[EntityDisplayDataTypeDef], # (2)ExperienceConfigurationOutputTypeDef#
# ExperienceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExperienceConfigurationOutputTypeDef
def get_value() -> ExperienceConfigurationOutputTypeDef:
return {
"ContentSourceConfiguration": ...,
}
# ExperienceConfigurationOutputTypeDef definition
class ExperienceConfigurationOutputTypeDef(TypedDict):
ContentSourceConfiguration: NotRequired[ContentSourceConfigurationOutputTypeDef], # (1)
UserIdentityConfiguration: NotRequired[UserIdentityConfigurationTypeDef], # (2)ExperienceConfigurationTypeDef#
# ExperienceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExperienceConfigurationTypeDef
def get_value() -> ExperienceConfigurationTypeDef:
return {
"ContentSourceConfiguration": ...,
}
# ExperienceConfigurationTypeDef definition
class ExperienceConfigurationTypeDef(TypedDict):
ContentSourceConfiguration: NotRequired[ContentSourceConfigurationTypeDef], # (1)
UserIdentityConfiguration: NotRequired[UserIdentityConfigurationTypeDef], # (2)ListFaqsResponseTypeDef#
# ListFaqsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListFaqsResponseTypeDef
def get_value() -> ListFaqsResponseTypeDef:
return {
"NextToken": ...,
}
# ListFaqsResponseTypeDef definition
class ListFaqsResponseTypeDef(TypedDict):
FaqSummaryItems: List[FaqSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[FaqSummaryTypeDef] - See ResponseMetadataTypeDef
ListFeaturedResultsSetsResponseTypeDef#
# ListFeaturedResultsSetsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListFeaturedResultsSetsResponseTypeDef
def get_value() -> ListFeaturedResultsSetsResponseTypeDef:
return {
"FeaturedResultsSetSummaryItems": ...,
}
# ListFeaturedResultsSetsResponseTypeDef definition
class ListFeaturedResultsSetsResponseTypeDef(TypedDict):
FeaturedResultsSetSummaryItems: List[FeaturedResultsSetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[FeaturedResultsSetSummaryTypeDef] - See ResponseMetadataTypeDef
GetSnapshotsResponseTypeDef#
# GetSnapshotsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GetSnapshotsResponseTypeDef
def get_value() -> GetSnapshotsResponseTypeDef:
return {
"SnapShotTimeFilter": ...,
}
# GetSnapshotsResponseTypeDef definition
class GetSnapshotsResponseTypeDef(TypedDict):
SnapShotTimeFilter: TimeRangeOutputTypeDef, # (1)
SnapshotsDataHeader: List[str],
SnapshotsData: List[List[str]],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],GroupMembersTypeDef#
# GroupMembersTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GroupMembersTypeDef
def get_value() -> GroupMembersTypeDef:
return {
"MemberGroups": ...,
}
# GroupMembersTypeDef definition
class GroupMembersTypeDef(TypedDict):
MemberGroups: NotRequired[Sequence[MemberGroupTypeDef]], # (1)
MemberUsers: NotRequired[Sequence[MemberUserTypeDef]], # (2)
S3PathforGroupMembers: NotRequired[S3PathTypeDef], # (3)- See
Sequence[MemberGroupTypeDef] - See
Sequence[MemberUserTypeDef] - See S3PathTypeDef
ListGroupsOlderThanOrderingIdResponseTypeDef#
# ListGroupsOlderThanOrderingIdResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListGroupsOlderThanOrderingIdResponseTypeDef
def get_value() -> ListGroupsOlderThanOrderingIdResponseTypeDef:
return {
"GroupsSummaries": ...,
}
# ListGroupsOlderThanOrderingIdResponseTypeDef definition
class ListGroupsOlderThanOrderingIdResponseTypeDef(TypedDict):
GroupsSummaries: List[GroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[GroupSummaryTypeDef] - See ResponseMetadataTypeDef
TextWithHighlightsTypeDef#
# TextWithHighlightsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TextWithHighlightsTypeDef
def get_value() -> TextWithHighlightsTypeDef:
return {
"Text": ...,
}
# TextWithHighlightsTypeDef definition
class TextWithHighlightsTypeDef(TypedDict):
Text: NotRequired[str],
Highlights: NotRequired[List[HighlightTypeDef]], # (1)- See
List[HighlightTypeDef]
ListIndicesResponseTypeDef#
# ListIndicesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListIndicesResponseTypeDef
def get_value() -> ListIndicesResponseTypeDef:
return {
"IndexConfigurationSummaryItems": ...,
}
# ListIndicesResponseTypeDef definition
class ListIndicesResponseTypeDef(TypedDict):
IndexConfigurationSummaryItems: List[IndexConfigurationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[IndexConfigurationSummaryTypeDef] - See ResponseMetadataTypeDef
IndexStatisticsTypeDef#
# IndexStatisticsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import IndexStatisticsTypeDef
def get_value() -> IndexStatisticsTypeDef:
return {
"FaqStatistics": ...,
}
# IndexStatisticsTypeDef definition
class IndexStatisticsTypeDef(TypedDict):
FaqStatistics: FaqStatisticsTypeDef, # (1)
TextDocumentStatistics: TextDocumentStatisticsTypeDef, # (2)UserTokenConfigurationTypeDef#
# UserTokenConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UserTokenConfigurationTypeDef
def get_value() -> UserTokenConfigurationTypeDef:
return {
"JwtTokenTypeConfiguration": ...,
}
# UserTokenConfigurationTypeDef definition
class UserTokenConfigurationTypeDef(TypedDict):
JwtTokenTypeConfiguration: NotRequired[JwtTokenTypeConfigurationTypeDef], # (1)
JsonTokenTypeConfiguration: NotRequired[JsonTokenTypeConfigurationTypeDef], # (2)ListEntityPersonasResponseTypeDef#
# ListEntityPersonasResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListEntityPersonasResponseTypeDef
def get_value() -> ListEntityPersonasResponseTypeDef:
return {
"SummaryItems": ...,
}
# ListEntityPersonasResponseTypeDef definition
class ListEntityPersonasResponseTypeDef(TypedDict):
SummaryItems: List[PersonasSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[PersonasSummaryTypeDef] - See ResponseMetadataTypeDef
ListQuerySuggestionsBlockListsResponseTypeDef#
# ListQuerySuggestionsBlockListsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListQuerySuggestionsBlockListsResponseTypeDef
def get_value() -> ListQuerySuggestionsBlockListsResponseTypeDef:
return {
"BlockListSummaryItems": ...,
}
# ListQuerySuggestionsBlockListsResponseTypeDef definition
class ListQuerySuggestionsBlockListsResponseTypeDef(TypedDict):
BlockListSummaryItems: List[QuerySuggestionsBlockListSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[QuerySuggestionsBlockListSummaryTypeDef] - See ResponseMetadataTypeDef
ListThesauriResponseTypeDef#
# ListThesauriResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListThesauriResponseTypeDef
def get_value() -> ListThesauriResponseTypeDef:
return {
"NextToken": ...,
}
# ListThesauriResponseTypeDef definition
class ListThesauriResponseTypeDef(TypedDict):
ThesaurusSummaryItems: List[ThesaurusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ThesaurusSummaryTypeDef] - See ResponseMetadataTypeDef
UrlsOutputTypeDef#
# UrlsOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UrlsOutputTypeDef
def get_value() -> UrlsOutputTypeDef:
return {
"SeedUrlConfiguration": ...,
}
# UrlsOutputTypeDef definition
class UrlsOutputTypeDef(TypedDict):
SeedUrlConfiguration: NotRequired[SeedUrlConfigurationOutputTypeDef], # (1)
SiteMapsConfiguration: NotRequired[SiteMapsConfigurationOutputTypeDef], # (2)UrlsTypeDef#
# UrlsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UrlsTypeDef
def get_value() -> UrlsTypeDef:
return {
"SeedUrlConfiguration": ...,
}
# UrlsTypeDef definition
class UrlsTypeDef(TypedDict):
SeedUrlConfiguration: NotRequired[SeedUrlConfigurationTypeDef], # (1)
SiteMapsConfiguration: NotRequired[SiteMapsConfigurationTypeDef], # (2)SuggestionTextWithHighlightsTypeDef#
# SuggestionTextWithHighlightsTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SuggestionTextWithHighlightsTypeDef
def get_value() -> SuggestionTextWithHighlightsTypeDef:
return {
"Text": ...,
}
# SuggestionTextWithHighlightsTypeDef definition
class SuggestionTextWithHighlightsTypeDef(TypedDict):
Text: NotRequired[str],
Highlights: NotRequired[List[SuggestionHighlightTypeDef]], # (1)- See
List[SuggestionHighlightTypeDef]
TableRowTypeDef#
# TableRowTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TableRowTypeDef
def get_value() -> TableRowTypeDef:
return {
"Cells": ...,
}
# TableRowTypeDef definition
class TableRowTypeDef(TypedDict):
Cells: NotRequired[List[TableCellTypeDef]], # (1)- See
List[TableCellTypeDef]
DatabaseConfigurationOutputTypeDef#
# DatabaseConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DatabaseConfigurationOutputTypeDef
def get_value() -> DatabaseConfigurationOutputTypeDef:
return {
"DatabaseEngineType": ...,
}
# DatabaseConfigurationOutputTypeDef definition
class DatabaseConfigurationOutputTypeDef(TypedDict):
DatabaseEngineType: DatabaseEngineTypeType, # (1)
ConnectionConfiguration: ConnectionConfigurationTypeDef, # (2)
ColumnConfiguration: ColumnConfigurationOutputTypeDef, # (4)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (3)
AclConfiguration: NotRequired[AclConfigurationTypeDef], # (5)
SqlConfiguration: NotRequired[SqlConfigurationTypeDef], # (6)- See DatabaseEngineTypeType
- See ConnectionConfigurationTypeDef
- See DataSourceVpcConfigurationOutputTypeDef
- See ColumnConfigurationOutputTypeDef
- See AclConfigurationTypeDef
- See SqlConfigurationTypeDef
DatabaseConfigurationTypeDef#
# DatabaseConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DatabaseConfigurationTypeDef
def get_value() -> DatabaseConfigurationTypeDef:
return {
"DatabaseEngineType": ...,
}
# DatabaseConfigurationTypeDef definition
class DatabaseConfigurationTypeDef(TypedDict):
DatabaseEngineType: DatabaseEngineTypeType, # (1)
ConnectionConfiguration: ConnectionConfigurationTypeDef, # (2)
ColumnConfiguration: ColumnConfigurationTypeDef, # (4)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (3)
AclConfiguration: NotRequired[AclConfigurationTypeDef], # (5)
SqlConfiguration: NotRequired[SqlConfigurationTypeDef], # (6)- See DatabaseEngineTypeType
- See ConnectionConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See ColumnConfigurationTypeDef
- See AclConfigurationTypeDef
- See SqlConfigurationTypeDef
SalesforceKnowledgeArticleConfigurationOutputTypeDef#
# SalesforceKnowledgeArticleConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceKnowledgeArticleConfigurationOutputTypeDef
def get_value() -> SalesforceKnowledgeArticleConfigurationOutputTypeDef:
return {
"IncludedStates": ...,
}
# SalesforceKnowledgeArticleConfigurationOutputTypeDef definition
class SalesforceKnowledgeArticleConfigurationOutputTypeDef(TypedDict):
IncludedStates: List[SalesforceKnowledgeArticleStateType], # (1)
StandardKnowledgeArticleTypeConfiguration: NotRequired[SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef], # (2)
CustomKnowledgeArticleTypeConfigurations: NotRequired[List[SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef]], # (3)- See
List[SalesforceKnowledgeArticleStateType] - See SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef
- See
List[SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef]
SalesforceKnowledgeArticleConfigurationTypeDef#
# SalesforceKnowledgeArticleConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceKnowledgeArticleConfigurationTypeDef
def get_value() -> SalesforceKnowledgeArticleConfigurationTypeDef:
return {
"IncludedStates": ...,
}
# SalesforceKnowledgeArticleConfigurationTypeDef definition
class SalesforceKnowledgeArticleConfigurationTypeDef(TypedDict):
IncludedStates: Sequence[SalesforceKnowledgeArticleStateType], # (1)
StandardKnowledgeArticleTypeConfiguration: NotRequired[SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef], # (2)
CustomKnowledgeArticleTypeConfigurations: NotRequired[Sequence[SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef]], # (3)- See
Sequence[SalesforceKnowledgeArticleStateType] - See SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
- See
Sequence[SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef]
ServiceNowConfigurationOutputTypeDef#
# ServiceNowConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowConfigurationOutputTypeDef
def get_value() -> ServiceNowConfigurationOutputTypeDef:
return {
"HostUrl": ...,
}
# ServiceNowConfigurationOutputTypeDef definition
class ServiceNowConfigurationOutputTypeDef(TypedDict):
HostUrl: str,
SecretArn: str,
ServiceNowBuildVersion: ServiceNowBuildVersionTypeType, # (1)
KnowledgeArticleConfiguration: NotRequired[ServiceNowKnowledgeArticleConfigurationOutputTypeDef], # (2)
ServiceCatalogConfiguration: NotRequired[ServiceNowServiceCatalogConfigurationOutputTypeDef], # (3)
AuthenticationType: NotRequired[ServiceNowAuthenticationTypeType], # (4)- See ServiceNowBuildVersionTypeType
- See ServiceNowKnowledgeArticleConfigurationOutputTypeDef
- See ServiceNowServiceCatalogConfigurationOutputTypeDef
- See ServiceNowAuthenticationTypeType
ServiceNowConfigurationTypeDef#
# ServiceNowConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ServiceNowConfigurationTypeDef
def get_value() -> ServiceNowConfigurationTypeDef:
return {
"HostUrl": ...,
}
# ServiceNowConfigurationTypeDef definition
class ServiceNowConfigurationTypeDef(TypedDict):
HostUrl: str,
SecretArn: str,
ServiceNowBuildVersion: ServiceNowBuildVersionTypeType, # (1)
KnowledgeArticleConfiguration: NotRequired[ServiceNowKnowledgeArticleConfigurationTypeDef], # (2)
ServiceCatalogConfiguration: NotRequired[ServiceNowServiceCatalogConfigurationTypeDef], # (3)
AuthenticationType: NotRequired[ServiceNowAuthenticationTypeType], # (4)- See ServiceNowBuildVersionTypeType
- See ServiceNowKnowledgeArticleConfigurationTypeDef
- See ServiceNowServiceCatalogConfigurationTypeDef
- See ServiceNowAuthenticationTypeType
GitHubConfigurationOutputTypeDef#
# GitHubConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GitHubConfigurationOutputTypeDef
def get_value() -> GitHubConfigurationOutputTypeDef:
return {
"SaaSConfiguration": ...,
}
# GitHubConfigurationOutputTypeDef definition
class GitHubConfigurationOutputTypeDef(TypedDict):
SecretArn: str,
SaaSConfiguration: NotRequired[SaaSConfigurationTypeDef], # (1)
OnPremiseConfiguration: NotRequired[OnPremiseConfigurationTypeDef], # (2)
Type: NotRequired[TypeType], # (3)
UseChangeLog: NotRequired[bool],
GitHubDocumentCrawlProperties: NotRequired[GitHubDocumentCrawlPropertiesTypeDef], # (4)
RepositoryFilter: NotRequired[List[str]],
InclusionFolderNamePatterns: NotRequired[List[str]],
InclusionFileTypePatterns: NotRequired[List[str]],
InclusionFileNamePatterns: NotRequired[List[str]],
ExclusionFolderNamePatterns: NotRequired[List[str]],
ExclusionFileTypePatterns: NotRequired[List[str]],
ExclusionFileNamePatterns: NotRequired[List[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (5)
GitHubRepositoryConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubCommitConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueDocumentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueCommentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueAttachmentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestCommentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestDocumentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (6)- See SaaSConfigurationTypeDef
- See OnPremiseConfigurationTypeDef
- See TypeType
- See GitHubDocumentCrawlPropertiesTypeDef
- See DataSourceVpcConfigurationOutputTypeDef
- See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef] - See
List[DataSourceToIndexFieldMappingTypeDef]
GitHubConfigurationTypeDef#
# GitHubConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GitHubConfigurationTypeDef
def get_value() -> GitHubConfigurationTypeDef:
return {
"SaaSConfiguration": ...,
}
# GitHubConfigurationTypeDef definition
class GitHubConfigurationTypeDef(TypedDict):
SecretArn: str,
SaaSConfiguration: NotRequired[SaaSConfigurationTypeDef], # (1)
OnPremiseConfiguration: NotRequired[OnPremiseConfigurationTypeDef], # (2)
Type: NotRequired[TypeType], # (3)
UseChangeLog: NotRequired[bool],
GitHubDocumentCrawlProperties: NotRequired[GitHubDocumentCrawlPropertiesTypeDef], # (4)
RepositoryFilter: NotRequired[Sequence[str]],
InclusionFolderNamePatterns: NotRequired[Sequence[str]],
InclusionFileTypePatterns: NotRequired[Sequence[str]],
InclusionFileNamePatterns: NotRequired[Sequence[str]],
ExclusionFolderNamePatterns: NotRequired[Sequence[str]],
ExclusionFileTypePatterns: NotRequired[Sequence[str]],
ExclusionFileNamePatterns: NotRequired[Sequence[str]],
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (5)
GitHubRepositoryConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubCommitConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueDocumentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueCommentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubIssueAttachmentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestCommentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestDocumentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (6)- See SaaSConfigurationTypeDef
- See OnPremiseConfigurationTypeDef
- See TypeType
- See GitHubDocumentCrawlPropertiesTypeDef
- See DataSourceVpcConfigurationTypeDef
- See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef] - See
Sequence[DataSourceToIndexFieldMappingTypeDef]
OneDriveConfigurationOutputTypeDef#
# OneDriveConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import OneDriveConfigurationOutputTypeDef
def get_value() -> OneDriveConfigurationOutputTypeDef:
return {
"TenantDomain": ...,
}
# OneDriveConfigurationOutputTypeDef definition
class OneDriveConfigurationOutputTypeDef(TypedDict):
TenantDomain: str,
SecretArn: str,
OneDriveUsers: OneDriveUsersOutputTypeDef, # (1)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
FieldMappings: NotRequired[List[DataSourceToIndexFieldMappingTypeDef]], # (2)
DisableLocalGroups: NotRequired[bool],- See OneDriveUsersOutputTypeDef
- See
List[DataSourceToIndexFieldMappingTypeDef]
OneDriveConfigurationTypeDef#
# OneDriveConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import OneDriveConfigurationTypeDef
def get_value() -> OneDriveConfigurationTypeDef:
return {
"TenantDomain": ...,
}
# OneDriveConfigurationTypeDef definition
class OneDriveConfigurationTypeDef(TypedDict):
TenantDomain: str,
SecretArn: str,
OneDriveUsers: OneDriveUsersTypeDef, # (1)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
DisableLocalGroups: NotRequired[bool],- See OneDriveUsersTypeDef
- See
Sequence[DataSourceToIndexFieldMappingTypeDef]
DescribeQuerySuggestionsConfigResponseTypeDef#
# DescribeQuerySuggestionsConfigResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeQuerySuggestionsConfigResponseTypeDef
def get_value() -> DescribeQuerySuggestionsConfigResponseTypeDef:
return {
"Mode": ...,
}
# DescribeQuerySuggestionsConfigResponseTypeDef definition
class DescribeQuerySuggestionsConfigResponseTypeDef(TypedDict):
Mode: ModeType, # (1)
Status: QuerySuggestionsStatusType, # (2)
QueryLogLookBackWindowInDays: int,
IncludeQueriesWithoutUserInformation: bool,
MinimumNumberOfQueryingUsers: int,
MinimumQueryCount: int,
LastSuggestionsBuildTime: datetime.datetime,
LastClearTime: datetime.datetime,
TotalSuggestionsCount: int,
AttributeSuggestionsConfig: AttributeSuggestionsDescribeConfigTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See ModeType
- See QuerySuggestionsStatusType
- See AttributeSuggestionsDescribeConfigTypeDef
- See ResponseMetadataTypeDef
UpdateQuerySuggestionsConfigRequestTypeDef#
# UpdateQuerySuggestionsConfigRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateQuerySuggestionsConfigRequestTypeDef
def get_value() -> UpdateQuerySuggestionsConfigRequestTypeDef:
return {
"IndexId": ...,
}
# UpdateQuerySuggestionsConfigRequestTypeDef definition
class UpdateQuerySuggestionsConfigRequestTypeDef(TypedDict):
IndexId: str,
Mode: NotRequired[ModeType], # (1)
QueryLogLookBackWindowInDays: NotRequired[int],
IncludeQueriesWithoutUserInformation: NotRequired[bool],
MinimumNumberOfQueryingUsers: NotRequired[int],
MinimumQueryCount: NotRequired[int],
AttributeSuggestionsConfig: NotRequired[AttributeSuggestionsUpdateConfigTypeDef], # (2)SubmitFeedbackRequestTypeDef#
# SubmitFeedbackRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SubmitFeedbackRequestTypeDef
def get_value() -> SubmitFeedbackRequestTypeDef:
return {
"IndexId": ...,
}
# SubmitFeedbackRequestTypeDef definition
class SubmitFeedbackRequestTypeDef(TypedDict):
IndexId: str,
QueryId: str,
ClickFeedbackItems: NotRequired[Sequence[ClickFeedbackTypeDef]], # (1)
RelevanceFeedbackItems: NotRequired[Sequence[RelevanceFeedbackTypeDef]], # (2)- See
Sequence[ClickFeedbackTypeDef] - See
Sequence[RelevanceFeedbackTypeDef]
DocumentAttributeConditionTypeDef#
# DocumentAttributeConditionTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeConditionTypeDef
def get_value() -> DocumentAttributeConditionTypeDef:
return {
"ConditionDocumentAttributeKey": ...,
}
# DocumentAttributeConditionTypeDef definition
class DocumentAttributeConditionTypeDef(TypedDict):
ConditionDocumentAttributeKey: str,
Operator: ConditionOperatorType, # (1)
ConditionOnValue: NotRequired[DocumentAttributeValueTypeDef], # (2)DocumentAttributeTargetTypeDef#
# DocumentAttributeTargetTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeTargetTypeDef
def get_value() -> DocumentAttributeTargetTypeDef:
return {
"TargetDocumentAttributeKey": ...,
}
# DocumentAttributeTargetTypeDef definition
class DocumentAttributeTargetTypeDef(TypedDict):
TargetDocumentAttributeKey: NotRequired[str],
TargetDocumentAttributeValueDeletion: NotRequired[bool],
TargetDocumentAttributeValue: NotRequired[DocumentAttributeValueTypeDef], # (1)ConfluenceConfigurationOutputTypeDef#
# ConfluenceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceConfigurationOutputTypeDef
def get_value() -> ConfluenceConfigurationOutputTypeDef:
return {
"ServerUrl": ...,
}
# ConfluenceConfigurationOutputTypeDef definition
class ConfluenceConfigurationOutputTypeDef(TypedDict):
ServerUrl: str,
SecretArn: str,
Version: ConfluenceVersionType, # (1)
SpaceConfiguration: NotRequired[ConfluenceSpaceConfigurationOutputTypeDef], # (2)
PageConfiguration: NotRequired[ConfluencePageConfigurationOutputTypeDef], # (3)
BlogConfiguration: NotRequired[ConfluenceBlogConfigurationOutputTypeDef], # (4)
AttachmentConfiguration: NotRequired[ConfluenceAttachmentConfigurationOutputTypeDef], # (5)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef], # (6)
InclusionPatterns: NotRequired[List[str]],
ExclusionPatterns: NotRequired[List[str]],
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (7)
AuthenticationType: NotRequired[ConfluenceAuthenticationTypeType], # (8)- See ConfluenceVersionType
- See ConfluenceSpaceConfigurationOutputTypeDef
- See ConfluencePageConfigurationOutputTypeDef
- See ConfluenceBlogConfigurationOutputTypeDef
- See ConfluenceAttachmentConfigurationOutputTypeDef
- See DataSourceVpcConfigurationOutputTypeDef
- See ProxyConfigurationTypeDef
- See ConfluenceAuthenticationTypeType
ConfluenceConfigurationTypeDef#
# ConfluenceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ConfluenceConfigurationTypeDef
def get_value() -> ConfluenceConfigurationTypeDef:
return {
"ServerUrl": ...,
}
# ConfluenceConfigurationTypeDef definition
class ConfluenceConfigurationTypeDef(TypedDict):
ServerUrl: str,
SecretArn: str,
Version: ConfluenceVersionType, # (1)
SpaceConfiguration: NotRequired[ConfluenceSpaceConfigurationTypeDef], # (2)
PageConfiguration: NotRequired[ConfluencePageConfigurationTypeDef], # (3)
BlogConfiguration: NotRequired[ConfluenceBlogConfigurationTypeDef], # (4)
AttachmentConfiguration: NotRequired[ConfluenceAttachmentConfigurationTypeDef], # (5)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (6)
InclusionPatterns: NotRequired[Sequence[str]],
ExclusionPatterns: NotRequired[Sequence[str]],
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (7)
AuthenticationType: NotRequired[ConfluenceAuthenticationTypeType], # (8)- See ConfluenceVersionType
- See ConfluenceSpaceConfigurationTypeDef
- See ConfluencePageConfigurationTypeDef
- See ConfluenceBlogConfigurationTypeDef
- See ConfluenceAttachmentConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See ProxyConfigurationTypeDef
- See ConfluenceAuthenticationTypeType
DescribeAccessControlConfigurationResponseTypeDef#
# DescribeAccessControlConfigurationResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeAccessControlConfigurationResponseTypeDef
def get_value() -> DescribeAccessControlConfigurationResponseTypeDef:
return {
"Name": ...,
}
# DescribeAccessControlConfigurationResponseTypeDef definition
class DescribeAccessControlConfigurationResponseTypeDef(TypedDict):
Name: str,
Description: str,
ErrorMessage: str,
AccessControlList: List[PrincipalTypeDef], # (1)
HierarchicalAccessControlList: List[HierarchicalPrincipalOutputTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See
List[PrincipalTypeDef] - See
List[HierarchicalPrincipalOutputTypeDef] - See ResponseMetadataTypeDef
CreateFeaturedResultsSetResponseTypeDef#
# CreateFeaturedResultsSetResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateFeaturedResultsSetResponseTypeDef
def get_value() -> CreateFeaturedResultsSetResponseTypeDef:
return {
"FeaturedResultsSet": ...,
}
# CreateFeaturedResultsSetResponseTypeDef definition
class CreateFeaturedResultsSetResponseTypeDef(TypedDict):
FeaturedResultsSet: FeaturedResultsSetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateFeaturedResultsSetResponseTypeDef#
# UpdateFeaturedResultsSetResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateFeaturedResultsSetResponseTypeDef
def get_value() -> UpdateFeaturedResultsSetResponseTypeDef:
return {
"FeaturedResultsSet": ...,
}
# UpdateFeaturedResultsSetResponseTypeDef definition
class UpdateFeaturedResultsSetResponseTypeDef(TypedDict):
FeaturedResultsSet: FeaturedResultsSetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDataSourceSyncJobsResponseTypeDef#
# ListDataSourceSyncJobsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListDataSourceSyncJobsResponseTypeDef
def get_value() -> ListDataSourceSyncJobsResponseTypeDef:
return {
"History": ...,
}
# ListDataSourceSyncJobsResponseTypeDef definition
class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
History: List[DataSourceSyncJobTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[DataSourceSyncJobTypeDef] - See ResponseMetadataTypeDef
ListExperiencesResponseTypeDef#
# ListExperiencesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListExperiencesResponseTypeDef
def get_value() -> ListExperiencesResponseTypeDef:
return {
"SummaryItems": ...,
}
# ListExperiencesResponseTypeDef definition
class ListExperiencesResponseTypeDef(TypedDict):
SummaryItems: List[ExperiencesSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ExperiencesSummaryTypeDef] - See ResponseMetadataTypeDef
HookConfigurationOutputTypeDef#
# HookConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import HookConfigurationOutputTypeDef
def get_value() -> HookConfigurationOutputTypeDef:
return {
"InvocationCondition": ...,
}
# HookConfigurationOutputTypeDef definition
class HookConfigurationOutputTypeDef(TypedDict):
LambdaArn: str,
S3Bucket: str,
InvocationCondition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)RetrieveResultItemTypeDef#
# RetrieveResultItemTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RetrieveResultItemTypeDef
def get_value() -> RetrieveResultItemTypeDef:
return {
"Id": ...,
}
# RetrieveResultItemTypeDef definition
class RetrieveResultItemTypeDef(TypedDict):
Id: NotRequired[str],
DocumentId: NotRequired[str],
DocumentTitle: NotRequired[str],
Content: NotRequired[str],
DocumentURI: NotRequired[str],
DocumentAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (1)
ScoreAttributes: NotRequired[ScoreAttributesTypeDef], # (2)- See
List[DocumentAttributeOutputTypeDef] - See ScoreAttributesTypeDef
SourceDocumentTypeDef#
# SourceDocumentTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SourceDocumentTypeDef
def get_value() -> SourceDocumentTypeDef:
return {
"DocumentId": ...,
}
# SourceDocumentTypeDef definition
class SourceDocumentTypeDef(TypedDict):
DocumentId: NotRequired[str],
SuggestionAttributes: NotRequired[List[str]],
AdditionalAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (1)- See
List[DocumentAttributeOutputTypeDef]
InlineCustomDocumentEnrichmentConfigurationOutputTypeDef#
# InlineCustomDocumentEnrichmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import InlineCustomDocumentEnrichmentConfigurationOutputTypeDef
def get_value() -> InlineCustomDocumentEnrichmentConfigurationOutputTypeDef:
return {
"Condition": ...,
}
# InlineCustomDocumentEnrichmentConfigurationOutputTypeDef definition
class InlineCustomDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
Condition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)
Target: NotRequired[DocumentAttributeTargetOutputTypeDef], # (2)
DocumentContentDeletion: NotRequired[bool],FacetResultTypeDef#
# FacetResultTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FacetResultTypeDef
def get_value() -> FacetResultTypeDef:
return {
"DocumentAttributeKey": ...,
}
# FacetResultTypeDef definition
class FacetResultTypeDef(TypedDict):
DocumentAttributeKey: NotRequired[str],
DocumentAttributeValueType: NotRequired[DocumentAttributeValueTypeType], # (1)
DocumentAttributeValueCountPairs: NotRequired[List[DocumentAttributeValueCountPairTypeDef]], # (2)- See DocumentAttributeValueTypeType
- See
List[DocumentAttributeValueCountPairTypeDef]
ListExperienceEntitiesResponseTypeDef#
# ListExperienceEntitiesResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListExperienceEntitiesResponseTypeDef
def get_value() -> ListExperienceEntitiesResponseTypeDef:
return {
"SummaryItems": ...,
}
# ListExperienceEntitiesResponseTypeDef definition
class ListExperienceEntitiesResponseTypeDef(TypedDict):
SummaryItems: List[ExperienceEntitiesSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],- See
List[ExperienceEntitiesSummaryTypeDef] - See ResponseMetadataTypeDef
DescribeExperienceResponseTypeDef#
# DescribeExperienceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeExperienceResponseTypeDef
def get_value() -> DescribeExperienceResponseTypeDef:
return {
"Id": ...,
}
# DescribeExperienceResponseTypeDef definition
class DescribeExperienceResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Endpoints: List[ExperienceEndpointTypeDef], # (1)
Configuration: ExperienceConfigurationOutputTypeDef, # (2)
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
Description: str,
Status: ExperienceStatusType, # (3)
RoleArn: str,
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See
List[ExperienceEndpointTypeDef] - See ExperienceConfigurationOutputTypeDef
- See ExperienceStatusType
- See ResponseMetadataTypeDef
PutPrincipalMappingRequestTypeDef#
# PutPrincipalMappingRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import PutPrincipalMappingRequestTypeDef
def get_value() -> PutPrincipalMappingRequestTypeDef:
return {
"IndexId": ...,
}
# PutPrincipalMappingRequestTypeDef definition
class PutPrincipalMappingRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
GroupMembers: GroupMembersTypeDef, # (1)
DataSourceId: NotRequired[str],
OrderingId: NotRequired[int],
RoleArn: NotRequired[str],AdditionalResultAttributeValueTypeDef#
# AdditionalResultAttributeValueTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AdditionalResultAttributeValueTypeDef
def get_value() -> AdditionalResultAttributeValueTypeDef:
return {
"TextWithHighlightsValue": ...,
}
# AdditionalResultAttributeValueTypeDef definition
class AdditionalResultAttributeValueTypeDef(TypedDict):
TextWithHighlightsValue: NotRequired[TextWithHighlightsTypeDef], # (1)ExpandedResultItemTypeDef#
# ExpandedResultItemTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ExpandedResultItemTypeDef
def get_value() -> ExpandedResultItemTypeDef:
return {
"Id": ...,
}
# ExpandedResultItemTypeDef definition
class ExpandedResultItemTypeDef(TypedDict):
Id: NotRequired[str],
DocumentId: NotRequired[str],
DocumentTitle: NotRequired[TextWithHighlightsTypeDef], # (1)
DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef], # (1)
DocumentURI: NotRequired[str],
DocumentAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (3)- See TextWithHighlightsTypeDef
- See TextWithHighlightsTypeDef
- See
List[DocumentAttributeOutputTypeDef]
CreateIndexRequestTypeDef#
# CreateIndexRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateIndexRequestTypeDef
def get_value() -> CreateIndexRequestTypeDef:
return {
"Name": ...,
}
# CreateIndexRequestTypeDef definition
class CreateIndexRequestTypeDef(TypedDict):
Name: str,
RoleArn: str,
Edition: NotRequired[IndexEditionType], # (1)
ServerSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
UserTokenConfigurations: NotRequired[Sequence[UserTokenConfigurationTypeDef]], # (4)
UserContextPolicy: NotRequired[UserContextPolicyType], # (5)
UserGroupResolutionConfiguration: NotRequired[UserGroupResolutionConfigurationTypeDef], # (6)- See IndexEditionType
- See ServerSideEncryptionConfigurationTypeDef
- See
Sequence[TagTypeDef] - See
Sequence[UserTokenConfigurationTypeDef] - See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
DescribeIndexResponseTypeDef#
# DescribeIndexResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeIndexResponseTypeDef
def get_value() -> DescribeIndexResponseTypeDef:
return {
"Name": ...,
}
# DescribeIndexResponseTypeDef definition
class DescribeIndexResponseTypeDef(TypedDict):
Name: str,
Id: str,
Edition: IndexEditionType, # (1)
RoleArn: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (2)
Status: IndexStatusType, # (3)
Description: str,
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
DocumentMetadataConfigurations: List[DocumentMetadataConfigurationOutputTypeDef], # (4)
IndexStatistics: IndexStatisticsTypeDef, # (5)
ErrorMessage: str,
CapacityUnits: CapacityUnitsConfigurationTypeDef, # (6)
UserTokenConfigurations: List[UserTokenConfigurationTypeDef], # (7)
UserContextPolicy: UserContextPolicyType, # (8)
UserGroupResolutionConfiguration: UserGroupResolutionConfigurationTypeDef, # (9)
ResponseMetadata: ResponseMetadataTypeDef, # (10)- See IndexEditionType
- See ServerSideEncryptionConfigurationTypeDef
- See IndexStatusType
- See
List[DocumentMetadataConfigurationOutputTypeDef] - See IndexStatisticsTypeDef
- See CapacityUnitsConfigurationTypeDef
- See
List[UserTokenConfigurationTypeDef] - See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
- See ResponseMetadataTypeDef
DocumentMetadataConfigurationTypeDef#
# DocumentMetadataConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentMetadataConfigurationTypeDef
def get_value() -> DocumentMetadataConfigurationTypeDef:
return {
"Name": ...,
}
# DocumentMetadataConfigurationTypeDef definition
class DocumentMetadataConfigurationTypeDef(TypedDict):
Name: str,
Type: DocumentAttributeValueTypeType, # (1)
Relevance: NotRequired[RelevanceUnionTypeDef], # (2)
Search: NotRequired[SearchTypeDef], # (3)DocumentRelevanceConfigurationTypeDef#
# DocumentRelevanceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentRelevanceConfigurationTypeDef
def get_value() -> DocumentRelevanceConfigurationTypeDef:
return {
"Name": ...,
}
# DocumentRelevanceConfigurationTypeDef definition
class DocumentRelevanceConfigurationTypeDef(TypedDict):
Name: str,
Relevance: RelevanceUnionTypeDef, # (1)WebCrawlerConfigurationOutputTypeDef#
# WebCrawlerConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import WebCrawlerConfigurationOutputTypeDef
def get_value() -> WebCrawlerConfigurationOutputTypeDef:
return {
"Urls": ...,
}
# WebCrawlerConfigurationOutputTypeDef definition
class WebCrawlerConfigurationOutputTypeDef(TypedDict):
Urls: UrlsOutputTypeDef, # (1)
CrawlDepth: NotRequired[int],
MaxLinksPerPage: NotRequired[int],
MaxContentSizePerPageInMegaBytes: NotRequired[float],
MaxUrlsPerMinuteCrawlRate: NotRequired[int],
UrlInclusionPatterns: NotRequired[List[str]],
UrlExclusionPatterns: NotRequired[List[str]],
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (2)
AuthenticationConfiguration: NotRequired[AuthenticationConfigurationOutputTypeDef], # (3)WebCrawlerConfigurationTypeDef#
# WebCrawlerConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import WebCrawlerConfigurationTypeDef
def get_value() -> WebCrawlerConfigurationTypeDef:
return {
"Urls": ...,
}
# WebCrawlerConfigurationTypeDef definition
class WebCrawlerConfigurationTypeDef(TypedDict):
Urls: UrlsTypeDef, # (1)
CrawlDepth: NotRequired[int],
MaxLinksPerPage: NotRequired[int],
MaxContentSizePerPageInMegaBytes: NotRequired[float],
MaxUrlsPerMinuteCrawlRate: NotRequired[int],
UrlInclusionPatterns: NotRequired[Sequence[str]],
UrlExclusionPatterns: NotRequired[Sequence[str]],
ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef], # (2)
AuthenticationConfiguration: NotRequired[AuthenticationConfigurationTypeDef], # (3)SuggestionValueTypeDef#
# SuggestionValueTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SuggestionValueTypeDef
def get_value() -> SuggestionValueTypeDef:
return {
"Text": ...,
}
# SuggestionValueTypeDef definition
class SuggestionValueTypeDef(TypedDict):
Text: NotRequired[SuggestionTextWithHighlightsTypeDef], # (1)TableExcerptTypeDef#
# TableExcerptTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import TableExcerptTypeDef
def get_value() -> TableExcerptTypeDef:
return {
"Rows": ...,
}
# TableExcerptTypeDef definition
class TableExcerptTypeDef(TypedDict):
Rows: NotRequired[List[TableRowTypeDef]], # (1)
TotalNumberOfRows: NotRequired[int],- See
List[TableRowTypeDef]
SalesforceConfigurationOutputTypeDef#
# SalesforceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceConfigurationOutputTypeDef
def get_value() -> SalesforceConfigurationOutputTypeDef:
return {
"ServerUrl": ...,
}
# SalesforceConfigurationOutputTypeDef definition
class SalesforceConfigurationOutputTypeDef(TypedDict):
ServerUrl: str,
SecretArn: str,
StandardObjectConfigurations: NotRequired[List[SalesforceStandardObjectConfigurationOutputTypeDef]], # (1)
KnowledgeArticleConfiguration: NotRequired[SalesforceKnowledgeArticleConfigurationOutputTypeDef], # (2)
ChatterFeedConfiguration: NotRequired[SalesforceChatterFeedConfigurationOutputTypeDef], # (3)
CrawlAttachments: NotRequired[bool],
StandardObjectAttachmentConfiguration: NotRequired[SalesforceStandardObjectAttachmentConfigurationOutputTypeDef], # (4)
IncludeAttachmentFilePatterns: NotRequired[List[str]],
ExcludeAttachmentFilePatterns: NotRequired[List[str]],- See
List[SalesforceStandardObjectConfigurationOutputTypeDef] - See SalesforceKnowledgeArticleConfigurationOutputTypeDef
- See SalesforceChatterFeedConfigurationOutputTypeDef
- See SalesforceStandardObjectAttachmentConfigurationOutputTypeDef
SalesforceConfigurationTypeDef#
# SalesforceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SalesforceConfigurationTypeDef
def get_value() -> SalesforceConfigurationTypeDef:
return {
"ServerUrl": ...,
}
# SalesforceConfigurationTypeDef definition
class SalesforceConfigurationTypeDef(TypedDict):
ServerUrl: str,
SecretArn: str,
StandardObjectConfigurations: NotRequired[Sequence[SalesforceStandardObjectConfigurationTypeDef]], # (1)
KnowledgeArticleConfiguration: NotRequired[SalesforceKnowledgeArticleConfigurationTypeDef], # (2)
ChatterFeedConfiguration: NotRequired[SalesforceChatterFeedConfigurationTypeDef], # (3)
CrawlAttachments: NotRequired[bool],
StandardObjectAttachmentConfiguration: NotRequired[SalesforceStandardObjectAttachmentConfigurationTypeDef], # (4)
IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],- See
Sequence[SalesforceStandardObjectConfigurationTypeDef] - See SalesforceKnowledgeArticleConfigurationTypeDef
- See SalesforceChatterFeedConfigurationTypeDef
- See SalesforceStandardObjectAttachmentConfigurationTypeDef
HookConfigurationTypeDef#
# HookConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import HookConfigurationTypeDef
def get_value() -> HookConfigurationTypeDef:
return {
"InvocationCondition": ...,
}
# HookConfigurationTypeDef definition
class HookConfigurationTypeDef(TypedDict):
LambdaArn: str,
S3Bucket: str,
InvocationCondition: NotRequired[DocumentAttributeConditionTypeDef], # (1)InlineCustomDocumentEnrichmentConfigurationTypeDef#
# InlineCustomDocumentEnrichmentConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import InlineCustomDocumentEnrichmentConfigurationTypeDef
def get_value() -> InlineCustomDocumentEnrichmentConfigurationTypeDef:
return {
"Condition": ...,
}
# InlineCustomDocumentEnrichmentConfigurationTypeDef definition
class InlineCustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
Condition: NotRequired[DocumentAttributeConditionTypeDef], # (1)
Target: NotRequired[DocumentAttributeTargetTypeDef], # (2)
DocumentContentDeletion: NotRequired[bool],DocumentAttributeTypeDef#
# DocumentAttributeTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentAttributeTypeDef
def get_value() -> DocumentAttributeTypeDef:
return {
"Key": ...,
}
# DocumentAttributeTypeDef definition
class DocumentAttributeTypeDef(TypedDict):
Key: str,
Value: DocumentAttributeValueUnionTypeDef, # (1)ListDataSourceSyncJobsRequestTypeDef#
# ListDataSourceSyncJobsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import ListDataSourceSyncJobsRequestTypeDef
def get_value() -> ListDataSourceSyncJobsRequestTypeDef:
return {
"Id": ...,
}
# ListDataSourceSyncJobsRequestTypeDef definition
class ListDataSourceSyncJobsRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StartTimeFilter: NotRequired[TimeRangeUnionTypeDef], # (1)
StatusFilter: NotRequired[DataSourceSyncJobStatusType], # (2)CreateAccessControlConfigurationRequestTypeDef#
# CreateAccessControlConfigurationRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateAccessControlConfigurationRequestTypeDef
def get_value() -> CreateAccessControlConfigurationRequestTypeDef:
return {
"IndexId": ...,
}
# CreateAccessControlConfigurationRequestTypeDef definition
class CreateAccessControlConfigurationRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
Description: NotRequired[str],
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (1)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalUnionTypeDef]], # (2)
ClientToken: NotRequired[str],- See
Sequence[PrincipalTypeDef] - See
Sequence[HierarchicalPrincipalUnionTypeDef]
UpdateAccessControlConfigurationRequestTypeDef#
# UpdateAccessControlConfigurationRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateAccessControlConfigurationRequestTypeDef
def get_value() -> UpdateAccessControlConfigurationRequestTypeDef:
return {
"IndexId": ...,
}
# UpdateAccessControlConfigurationRequestTypeDef definition
class UpdateAccessControlConfigurationRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: NotRequired[str],
Description: NotRequired[str],
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (1)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalUnionTypeDef]], # (2)- See
Sequence[PrincipalTypeDef] - See
Sequence[HierarchicalPrincipalUnionTypeDef]
RetrieveResultTypeDef#
# RetrieveResultTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RetrieveResultTypeDef
def get_value() -> RetrieveResultTypeDef:
return {
"QueryId": ...,
}
# RetrieveResultTypeDef definition
class RetrieveResultTypeDef(TypedDict):
QueryId: str,
ResultItems: List[RetrieveResultItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[RetrieveResultItemTypeDef] - See ResponseMetadataTypeDef
CustomDocumentEnrichmentConfigurationOutputTypeDef#
# CustomDocumentEnrichmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CustomDocumentEnrichmentConfigurationOutputTypeDef
def get_value() -> CustomDocumentEnrichmentConfigurationOutputTypeDef:
return {
"InlineConfigurations": ...,
}
# CustomDocumentEnrichmentConfigurationOutputTypeDef definition
class CustomDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
InlineConfigurations: NotRequired[List[InlineCustomDocumentEnrichmentConfigurationOutputTypeDef]], # (1)
PreExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)
PostExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)
RoleArn: NotRequired[str],- See
List[InlineCustomDocumentEnrichmentConfigurationOutputTypeDef] - See HookConfigurationOutputTypeDef
- See HookConfigurationOutputTypeDef
CreateExperienceRequestTypeDef#
# CreateExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateExperienceRequestTypeDef
def get_value() -> CreateExperienceRequestTypeDef:
return {
"Name": ...,
}
# CreateExperienceRequestTypeDef definition
class CreateExperienceRequestTypeDef(TypedDict):
Name: str,
IndexId: str,
RoleArn: NotRequired[str],
Configuration: NotRequired[ExperienceConfigurationUnionTypeDef], # (1)
Description: NotRequired[str],
ClientToken: NotRequired[str],UpdateExperienceRequestTypeDef#
# UpdateExperienceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateExperienceRequestTypeDef
def get_value() -> UpdateExperienceRequestTypeDef:
return {
"Id": ...,
}
# UpdateExperienceRequestTypeDef definition
class UpdateExperienceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
RoleArn: NotRequired[str],
Configuration: NotRequired[ExperienceConfigurationUnionTypeDef], # (1)
Description: NotRequired[str],AdditionalResultAttributeTypeDef#
# AdditionalResultAttributeTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AdditionalResultAttributeTypeDef
def get_value() -> AdditionalResultAttributeTypeDef:
return {
"Key": ...,
}
# AdditionalResultAttributeTypeDef definition
class AdditionalResultAttributeTypeDef(TypedDict):
Key: str,
ValueType: AdditionalResultAttributeValueTypeType, # (1)
Value: AdditionalResultAttributeValueTypeDef, # (2)CollapsedResultDetailTypeDef#
# CollapsedResultDetailTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CollapsedResultDetailTypeDef
def get_value() -> CollapsedResultDetailTypeDef:
return {
"DocumentAttribute": ...,
}
# CollapsedResultDetailTypeDef definition
class CollapsedResultDetailTypeDef(TypedDict):
DocumentAttribute: DocumentAttributeOutputTypeDef, # (1)
ExpandedResults: NotRequired[List[ExpandedResultItemTypeDef]], # (2)- See DocumentAttributeOutputTypeDef
- See
List[ExpandedResultItemTypeDef]
SuggestionTypeDef#
# SuggestionTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import SuggestionTypeDef
def get_value() -> SuggestionTypeDef:
return {
"Id": ...,
}
# SuggestionTypeDef definition
class SuggestionTypeDef(TypedDict):
Id: NotRequired[str],
Value: NotRequired[SuggestionValueTypeDef], # (1)
SourceDocuments: NotRequired[List[SourceDocumentTypeDef]], # (2)- See SuggestionValueTypeDef
- See
List[SourceDocumentTypeDef]
DataSourceConfigurationOutputTypeDef#
# DataSourceConfigurationOutputTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceConfigurationOutputTypeDef
def get_value() -> DataSourceConfigurationOutputTypeDef:
return {
"S3Configuration": ...,
}
# DataSourceConfigurationOutputTypeDef definition
class DataSourceConfigurationOutputTypeDef(TypedDict):
S3Configuration: NotRequired[S3DataSourceConfigurationOutputTypeDef], # (1)
SharePointConfiguration: NotRequired[SharePointConfigurationOutputTypeDef], # (2)
DatabaseConfiguration: NotRequired[DatabaseConfigurationOutputTypeDef], # (3)
SalesforceConfiguration: NotRequired[SalesforceConfigurationOutputTypeDef], # (4)
OneDriveConfiguration: NotRequired[OneDriveConfigurationOutputTypeDef], # (5)
ServiceNowConfiguration: NotRequired[ServiceNowConfigurationOutputTypeDef], # (6)
ConfluenceConfiguration: NotRequired[ConfluenceConfigurationOutputTypeDef], # (7)
GoogleDriveConfiguration: NotRequired[GoogleDriveConfigurationOutputTypeDef], # (8)
WebCrawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef], # (9)
WorkDocsConfiguration: NotRequired[WorkDocsConfigurationOutputTypeDef], # (10)
FsxConfiguration: NotRequired[FsxConfigurationOutputTypeDef], # (11)
SlackConfiguration: NotRequired[SlackConfigurationOutputTypeDef], # (12)
BoxConfiguration: NotRequired[BoxConfigurationOutputTypeDef], # (13)
QuipConfiguration: NotRequired[QuipConfigurationOutputTypeDef], # (14)
JiraConfiguration: NotRequired[JiraConfigurationOutputTypeDef], # (15)
GitHubConfiguration: NotRequired[GitHubConfigurationOutputTypeDef], # (16)
AlfrescoConfiguration: NotRequired[AlfrescoConfigurationOutputTypeDef], # (17)
TemplateConfiguration: NotRequired[TemplateConfigurationOutputTypeDef], # (18)- See S3DataSourceConfigurationOutputTypeDef
- See SharePointConfigurationOutputTypeDef
- See DatabaseConfigurationOutputTypeDef
- See SalesforceConfigurationOutputTypeDef
- See OneDriveConfigurationOutputTypeDef
- See ServiceNowConfigurationOutputTypeDef
- See ConfluenceConfigurationOutputTypeDef
- See GoogleDriveConfigurationOutputTypeDef
- See WebCrawlerConfigurationOutputTypeDef
- See WorkDocsConfigurationOutputTypeDef
- See FsxConfigurationOutputTypeDef
- See SlackConfigurationOutputTypeDef
- See BoxConfigurationOutputTypeDef
- See QuipConfigurationOutputTypeDef
- See JiraConfigurationOutputTypeDef
- See GitHubConfigurationOutputTypeDef
- See AlfrescoConfigurationOutputTypeDef
- See TemplateConfigurationOutputTypeDef
DataSourceConfigurationTypeDef#
# DataSourceConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DataSourceConfigurationTypeDef
def get_value() -> DataSourceConfigurationTypeDef:
return {
"S3Configuration": ...,
}
# DataSourceConfigurationTypeDef definition
class DataSourceConfigurationTypeDef(TypedDict):
S3Configuration: NotRequired[S3DataSourceConfigurationTypeDef], # (1)
SharePointConfiguration: NotRequired[SharePointConfigurationTypeDef], # (2)
DatabaseConfiguration: NotRequired[DatabaseConfigurationTypeDef], # (3)
SalesforceConfiguration: NotRequired[SalesforceConfigurationTypeDef], # (4)
OneDriveConfiguration: NotRequired[OneDriveConfigurationTypeDef], # (5)
ServiceNowConfiguration: NotRequired[ServiceNowConfigurationTypeDef], # (6)
ConfluenceConfiguration: NotRequired[ConfluenceConfigurationTypeDef], # (7)
GoogleDriveConfiguration: NotRequired[GoogleDriveConfigurationTypeDef], # (8)
WebCrawlerConfiguration: NotRequired[WebCrawlerConfigurationTypeDef], # (9)
WorkDocsConfiguration: NotRequired[WorkDocsConfigurationTypeDef], # (10)
FsxConfiguration: NotRequired[FsxConfigurationTypeDef], # (11)
SlackConfiguration: NotRequired[SlackConfigurationTypeDef], # (12)
BoxConfiguration: NotRequired[BoxConfigurationTypeDef], # (13)
QuipConfiguration: NotRequired[QuipConfigurationTypeDef], # (14)
JiraConfiguration: NotRequired[JiraConfigurationTypeDef], # (15)
GitHubConfiguration: NotRequired[GitHubConfigurationTypeDef], # (16)
AlfrescoConfiguration: NotRequired[AlfrescoConfigurationTypeDef], # (17)
TemplateConfiguration: NotRequired[TemplateConfigurationTypeDef], # (18)- See S3DataSourceConfigurationTypeDef
- See SharePointConfigurationTypeDef
- See DatabaseConfigurationTypeDef
- See SalesforceConfigurationTypeDef
- See OneDriveConfigurationTypeDef
- See ServiceNowConfigurationTypeDef
- See ConfluenceConfigurationTypeDef
- See GoogleDriveConfigurationTypeDef
- See WebCrawlerConfigurationTypeDef
- See WorkDocsConfigurationTypeDef
- See FsxConfigurationTypeDef
- See SlackConfigurationTypeDef
- See BoxConfigurationTypeDef
- See QuipConfigurationTypeDef
- See JiraConfigurationTypeDef
- See GitHubConfigurationTypeDef
- See AlfrescoConfigurationTypeDef
- See TemplateConfigurationTypeDef
CustomDocumentEnrichmentConfigurationTypeDef#
# CustomDocumentEnrichmentConfigurationTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CustomDocumentEnrichmentConfigurationTypeDef
def get_value() -> CustomDocumentEnrichmentConfigurationTypeDef:
return {
"InlineConfigurations": ...,
}
# CustomDocumentEnrichmentConfigurationTypeDef definition
class CustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
InlineConfigurations: NotRequired[Sequence[InlineCustomDocumentEnrichmentConfigurationTypeDef]], # (1)
PreExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
PostExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
RoleArn: NotRequired[str],- See
Sequence[InlineCustomDocumentEnrichmentConfigurationTypeDef] - See HookConfigurationTypeDef
- See HookConfigurationTypeDef
FeaturedResultsItemTypeDef#
# FeaturedResultsItemTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import FeaturedResultsItemTypeDef
def get_value() -> FeaturedResultsItemTypeDef:
return {
"Id": ...,
}
# FeaturedResultsItemTypeDef definition
class FeaturedResultsItemTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[QueryResultTypeType], # (1)
AdditionalAttributes: NotRequired[List[AdditionalResultAttributeTypeDef]], # (2)
DocumentId: NotRequired[str],
DocumentTitle: NotRequired[TextWithHighlightsTypeDef], # (3)
DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef], # (3)
DocumentURI: NotRequired[str],
DocumentAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (5)
FeedbackToken: NotRequired[str],- See QueryResultTypeType
- See
List[AdditionalResultAttributeTypeDef] - See TextWithHighlightsTypeDef
- See TextWithHighlightsTypeDef
- See
List[DocumentAttributeOutputTypeDef]
QueryResultItemTypeDef#
# QueryResultItemTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QueryResultItemTypeDef
def get_value() -> QueryResultItemTypeDef:
return {
"Id": ...,
}
# QueryResultItemTypeDef definition
class QueryResultItemTypeDef(TypedDict):
Id: NotRequired[str],
Type: NotRequired[QueryResultTypeType], # (1)
Format: NotRequired[QueryResultFormatType], # (2)
AdditionalAttributes: NotRequired[List[AdditionalResultAttributeTypeDef]], # (3)
DocumentId: NotRequired[str],
DocumentTitle: NotRequired[TextWithHighlightsTypeDef], # (4)
DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef], # (4)
DocumentURI: NotRequired[str],
DocumentAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (6)
ScoreAttributes: NotRequired[ScoreAttributesTypeDef], # (7)
FeedbackToken: NotRequired[str],
TableExcerpt: NotRequired[TableExcerptTypeDef], # (8)
CollapsedResultDetail: NotRequired[CollapsedResultDetailTypeDef], # (9)- See QueryResultTypeType
- See QueryResultFormatType
- See
List[AdditionalResultAttributeTypeDef] - See TextWithHighlightsTypeDef
- See TextWithHighlightsTypeDef
- See
List[DocumentAttributeOutputTypeDef] - See ScoreAttributesTypeDef
- See TableExcerptTypeDef
- See CollapsedResultDetailTypeDef
UpdateIndexRequestTypeDef#
# UpdateIndexRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateIndexRequestTypeDef
def get_value() -> UpdateIndexRequestTypeDef:
return {
"Id": ...,
}
# UpdateIndexRequestTypeDef definition
class UpdateIndexRequestTypeDef(TypedDict):
Id: str,
Name: NotRequired[str],
RoleArn: NotRequired[str],
Description: NotRequired[str],
DocumentMetadataConfigurationUpdates: NotRequired[Sequence[DocumentMetadataConfigurationUnionTypeDef]], # (1)
CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef], # (2)
UserTokenConfigurations: NotRequired[Sequence[UserTokenConfigurationTypeDef]], # (3)
UserContextPolicy: NotRequired[UserContextPolicyType], # (4)
UserGroupResolutionConfiguration: NotRequired[UserGroupResolutionConfigurationTypeDef], # (5)- See
Sequence[DocumentMetadataConfigurationUnionTypeDef] - See CapacityUnitsConfigurationTypeDef
- See
Sequence[UserTokenConfigurationTypeDef] - See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
GetQuerySuggestionsResponseTypeDef#
# GetQuerySuggestionsResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GetQuerySuggestionsResponseTypeDef
def get_value() -> GetQuerySuggestionsResponseTypeDef:
return {
"QuerySuggestionsId": ...,
}
# GetQuerySuggestionsResponseTypeDef definition
class GetQuerySuggestionsResponseTypeDef(TypedDict):
QuerySuggestionsId: str,
Suggestions: List[SuggestionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See
List[SuggestionTypeDef] - See ResponseMetadataTypeDef
DescribeDataSourceResponseTypeDef#
# DescribeDataSourceResponseTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DescribeDataSourceResponseTypeDef
def get_value() -> DescribeDataSourceResponseTypeDef:
return {
"Id": ...,
}
# DescribeDataSourceResponseTypeDef definition
class DescribeDataSourceResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Type: DataSourceTypeType, # (1)
Configuration: DataSourceConfigurationOutputTypeDef, # (2)
VpcConfiguration: DataSourceVpcConfigurationOutputTypeDef, # (3)
CreatedAt: datetime.datetime,
UpdatedAt: datetime.datetime,
Description: str,
Status: DataSourceStatusType, # (4)
Schedule: str,
RoleArn: str,
ErrorMessage: str,
LanguageCode: str,
CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationOutputTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See DataSourceTypeType
- See DataSourceConfigurationOutputTypeDef
- See DataSourceVpcConfigurationOutputTypeDef
- See DataSourceStatusType
- See CustomDocumentEnrichmentConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
AttributeFilterTypeDef#
# AttributeFilterTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AttributeFilterTypeDef
def get_value() -> AttributeFilterTypeDef:
return {
"AndAllFilters": ...,
}
# AttributeFilterTypeDef definition
class AttributeFilterTypeDef(TypedDict):
AndAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
OrAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
NotFilter: NotRequired[Mapping[str, Any]],
EqualsTo: NotRequired[DocumentAttributeUnionTypeDef], # (1)
ContainsAll: NotRequired[DocumentAttributeUnionTypeDef], # (1)
ContainsAny: NotRequired[DocumentAttributeUnionTypeDef], # (1)
GreaterThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
GreaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)
LessThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
LessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
- See DocumentAttributeUnionTypeDef
DocumentInfoTypeDef#
# DocumentInfoTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentInfoTypeDef
def get_value() -> DocumentInfoTypeDef:
return {
"DocumentId": ...,
}
# DocumentInfoTypeDef definition
class DocumentInfoTypeDef(TypedDict):
DocumentId: str,
Attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]], # (1)- See
Sequence[DocumentAttributeUnionTypeDef]
DocumentTypeDef#
# DocumentTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"Id": ...,
}
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
Id: str,
Title: NotRequired[str],
Blob: NotRequired[BlobTypeDef],
S3Path: NotRequired[S3PathTypeDef], # (1)
Attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]], # (2)
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (3)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalUnionTypeDef]], # (4)
ContentType: NotRequired[ContentTypeType], # (5)
AccessControlConfigurationId: NotRequired[str],- See S3PathTypeDef
- See
Sequence[DocumentAttributeUnionTypeDef] - See
Sequence[PrincipalTypeDef] - See
Sequence[HierarchicalPrincipalUnionTypeDef] - See ContentTypeType
QueryResultTypeDef#
# QueryResultTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QueryResultTypeDef
def get_value() -> QueryResultTypeDef:
return {
"QueryId": ...,
}
# QueryResultTypeDef definition
class QueryResultTypeDef(TypedDict):
QueryId: str,
ResultItems: List[QueryResultItemTypeDef], # (1)
FacetResults: List[FacetResultTypeDef], # (2)
TotalNumberOfResults: int,
Warnings: List[WarningTypeDef], # (3)
SpellCorrectedQueries: List[SpellCorrectedQueryTypeDef], # (4)
FeaturedResultsItems: List[FeaturedResultsItemTypeDef], # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See
List[QueryResultItemTypeDef] - See
List[FacetResultTypeDef] - See
List[WarningTypeDef] - See
List[SpellCorrectedQueryTypeDef] - See
List[FeaturedResultsItemTypeDef] - See ResponseMetadataTypeDef
CreateDataSourceRequestTypeDef#
# CreateDataSourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import CreateDataSourceRequestTypeDef
def get_value() -> CreateDataSourceRequestTypeDef:
return {
"Name": ...,
}
# CreateDataSourceRequestTypeDef definition
class CreateDataSourceRequestTypeDef(TypedDict):
Name: str,
IndexId: str,
Type: DataSourceTypeType, # (1)
Configuration: NotRequired[DataSourceConfigurationUnionTypeDef], # (2)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef], # (3)
Description: NotRequired[str],
Schedule: NotRequired[str],
RoleArn: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
ClientToken: NotRequired[str],
LanguageCode: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationUnionTypeDef], # (5)- See DataSourceTypeType
- See DataSourceConfigurationUnionTypeDef
- See DataSourceVpcConfigurationUnionTypeDef
- See
Sequence[TagTypeDef] - See CustomDocumentEnrichmentConfigurationUnionTypeDef
UpdateDataSourceRequestTypeDef#
# UpdateDataSourceRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import UpdateDataSourceRequestTypeDef
def get_value() -> UpdateDataSourceRequestTypeDef:
return {
"Id": ...,
}
# UpdateDataSourceRequestTypeDef definition
class UpdateDataSourceRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
Configuration: NotRequired[DataSourceConfigurationUnionTypeDef], # (1)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef], # (2)
Description: NotRequired[str],
Schedule: NotRequired[str],
RoleArn: NotRequired[str],
LanguageCode: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationUnionTypeDef], # (3)- See DataSourceConfigurationUnionTypeDef
- See DataSourceVpcConfigurationUnionTypeDef
- See CustomDocumentEnrichmentConfigurationUnionTypeDef
AttributeSuggestionsGetConfigTypeDef#
# AttributeSuggestionsGetConfigTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import AttributeSuggestionsGetConfigTypeDef
def get_value() -> AttributeSuggestionsGetConfigTypeDef:
return {
"SuggestionAttributes": ...,
}
# AttributeSuggestionsGetConfigTypeDef definition
class AttributeSuggestionsGetConfigTypeDef(TypedDict):
SuggestionAttributes: NotRequired[Sequence[str]],
AdditionalResponseAttributes: NotRequired[Sequence[str]],
AttributeFilter: NotRequired[AttributeFilterTypeDef], # (1)
UserContext: NotRequired[UserContextTypeDef], # (2)QueryRequestTypeDef#
# QueryRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import QueryRequestTypeDef
def get_value() -> QueryRequestTypeDef:
return {
"IndexId": ...,
}
# QueryRequestTypeDef definition
class QueryRequestTypeDef(TypedDict):
IndexId: str,
QueryText: NotRequired[str],
AttributeFilter: NotRequired[AttributeFilterTypeDef], # (1)
Facets: NotRequired[Sequence[FacetTypeDef]], # (2)
RequestedDocumentAttributes: NotRequired[Sequence[str]],
QueryResultTypeFilter: NotRequired[QueryResultTypeType], # (3)
DocumentRelevanceOverrideConfigurations: NotRequired[Sequence[DocumentRelevanceConfigurationTypeDef]], # (4)
PageNumber: NotRequired[int],
PageSize: NotRequired[int],
SortingConfiguration: NotRequired[SortingConfigurationTypeDef], # (5)
SortingConfigurations: NotRequired[Sequence[SortingConfigurationTypeDef]], # (6)
UserContext: NotRequired[UserContextTypeDef], # (7)
VisitorId: NotRequired[str],
SpellCorrectionConfiguration: NotRequired[SpellCorrectionConfigurationTypeDef], # (8)
CollapseConfiguration: NotRequired[CollapseConfigurationTypeDef], # (9)- See AttributeFilterTypeDef
- See
Sequence[FacetTypeDef] - See QueryResultTypeType
- See
Sequence[DocumentRelevanceConfigurationTypeDef] - See SortingConfigurationTypeDef
- See
Sequence[SortingConfigurationTypeDef] - See UserContextTypeDef
- See SpellCorrectionConfigurationTypeDef
- See CollapseConfigurationTypeDef
RetrieveRequestTypeDef#
# RetrieveRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import RetrieveRequestTypeDef
def get_value() -> RetrieveRequestTypeDef:
return {
"IndexId": ...,
}
# RetrieveRequestTypeDef definition
class RetrieveRequestTypeDef(TypedDict):
IndexId: str,
QueryText: str,
AttributeFilter: NotRequired[AttributeFilterTypeDef], # (1)
RequestedDocumentAttributes: NotRequired[Sequence[str]],
DocumentRelevanceOverrideConfigurations: NotRequired[Sequence[DocumentRelevanceConfigurationTypeDef]], # (2)
PageNumber: NotRequired[int],
PageSize: NotRequired[int],
UserContext: NotRequired[UserContextTypeDef], # (3)- See AttributeFilterTypeDef
- See
Sequence[DocumentRelevanceConfigurationTypeDef] - See UserContextTypeDef
BatchGetDocumentStatusRequestTypeDef#
# BatchGetDocumentStatusRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchGetDocumentStatusRequestTypeDef
def get_value() -> BatchGetDocumentStatusRequestTypeDef:
return {
"IndexId": ...,
}
# BatchGetDocumentStatusRequestTypeDef definition
class BatchGetDocumentStatusRequestTypeDef(TypedDict):
IndexId: str,
DocumentInfoList: Sequence[DocumentInfoTypeDef], # (1)- See
Sequence[DocumentInfoTypeDef]
BatchPutDocumentRequestTypeDef#
# BatchPutDocumentRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import BatchPutDocumentRequestTypeDef
def get_value() -> BatchPutDocumentRequestTypeDef:
return {
"IndexId": ...,
}
# BatchPutDocumentRequestTypeDef definition
class BatchPutDocumentRequestTypeDef(TypedDict):
IndexId: str,
Documents: Sequence[DocumentTypeDef], # (1)
RoleArn: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationUnionTypeDef], # (2)- See
Sequence[DocumentTypeDef] - See CustomDocumentEnrichmentConfigurationUnionTypeDef
GetQuerySuggestionsRequestTypeDef#
# GetQuerySuggestionsRequestTypeDef TypedDict usage example
from types_boto3_kendra.type_defs import GetQuerySuggestionsRequestTypeDef
def get_value() -> GetQuerySuggestionsRequestTypeDef:
return {
"IndexId": ...,
}
# GetQuerySuggestionsRequestTypeDef definition
class GetQuerySuggestionsRequestTypeDef(TypedDict):
IndexId: str,
QueryText: str,
MaxSuggestionsCount: NotRequired[int],
SuggestionTypes: NotRequired[Sequence[SuggestionTypeType]], # (1)
AttributeSuggestionsConfig: NotRequired[AttributeSuggestionsGetConfigTypeDef], # (2)- See
Sequence[SuggestionTypeType] - See AttributeSuggestionsGetConfigTypeDef