Typed dictionaries
Auto-generated documentation for kendra type annotations stubs module types-aiobotocore-kendra.
AccessControlConfigurationSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AccessControlConfigurationSummaryTypeDef
def get_value() -> AccessControlConfigurationSummaryTypeDef:
return {
"Id": ...,
}
AccessControlListConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AccessControlListConfigurationTypeDef
def get_value() -> AccessControlListConfigurationTypeDef:
return {
"KeyPath": ...,
}
AclConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AclConfigurationTypeDef
def get_value() -> AclConfigurationTypeDef:
return {
"AllowedGroupsColumnName": ...,
}
DataSourceToIndexFieldMappingTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceToIndexFieldMappingTypeDef
def get_value() -> DataSourceToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
"IndexFieldName": ...,
}
Definition
class DataSourceToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: str,
IndexFieldName: str,
DateFieldFormat: NotRequired[str],
DataSourceVpcConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceVpcConfigurationTypeDef
def get_value() -> DataSourceVpcConfigurationTypeDef:
return {
"SubnetIds": ...,
"SecurityGroupIds": ...,
}
Definition
class DataSourceVpcConfigurationTypeDef(TypedDict):
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
S3PathTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import S3PathTypeDef
def get_value() -> S3PathTypeDef:
return {
"Bucket": ...,
"Key": ...,
}
EntityConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import EntityConfigurationTypeDef
def get_value() -> EntityConfigurationTypeDef:
return {
"EntityId": ...,
"EntityType": ...,
}
Definition
class EntityConfigurationTypeDef(TypedDict):
EntityId: str,
EntityType: EntityTypeType, # (1)
- See EntityTypeType
FailedEntityTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FailedEntityTypeDef
def get_value() -> FailedEntityTypeDef:
return {
"EntityId": ...,
}
Definition
class FailedEntityTypeDef(TypedDict):
EntityId: NotRequired[str],
ErrorMessage: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EntityPersonaConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import EntityPersonaConfigurationTypeDef
def get_value() -> EntityPersonaConfigurationTypeDef:
return {
"EntityId": ...,
"Persona": ...,
}
Definition
class EntityPersonaConfigurationTypeDef(TypedDict):
EntityId: str,
Persona: PersonaType, # (1)
- See PersonaType
BasicAuthenticationConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BasicAuthenticationConfigurationTypeDef
def get_value() -> BasicAuthenticationConfigurationTypeDef:
return {
"Host": ...,
"Port": ...,
"Credentials": ...,
}
Definition
class BasicAuthenticationConfigurationTypeDef(TypedDict):
Host: str,
Port: int,
Credentials: str,
DataSourceSyncJobMetricTargetTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceSyncJobMetricTargetTypeDef
def get_value() -> DataSourceSyncJobMetricTargetTypeDef:
return {
"DataSourceId": ...,
}
Definition
class DataSourceSyncJobMetricTargetTypeDef(TypedDict):
DataSourceId: str,
DataSourceSyncJobId: NotRequired[str],
BatchDeleteDocumentResponseFailedDocumentTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchDeleteDocumentResponseFailedDocumentTypeDef
def get_value() -> BatchDeleteDocumentResponseFailedDocumentTypeDef:
return {
"Id": ...,
}
Definition
class BatchDeleteDocumentResponseFailedDocumentTypeDef(TypedDict):
Id: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
- See ErrorCodeType
BatchGetDocumentStatusResponseErrorTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchGetDocumentStatusResponseErrorTypeDef
def get_value() -> BatchGetDocumentStatusResponseErrorTypeDef:
return {
"DocumentId": ...,
}
Definition
class BatchGetDocumentStatusResponseErrorTypeDef(TypedDict):
DocumentId: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
- See ErrorCodeType
StatusTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import StatusTypeDef
def get_value() -> StatusTypeDef:
return {
"DocumentId": ...,
}
Definition
class StatusTypeDef(TypedDict):
DocumentId: NotRequired[str],
DocumentStatus: NotRequired[DocumentStatusType], # (1)
FailureCode: NotRequired[str],
FailureReason: NotRequired[str],
BatchPutDocumentResponseFailedDocumentTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchPutDocumentResponseFailedDocumentTypeDef
def get_value() -> BatchPutDocumentResponseFailedDocumentTypeDef:
return {
"Id": ...,
}
Definition
class BatchPutDocumentResponseFailedDocumentTypeDef(TypedDict):
Id: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
- See ErrorCodeType
CapacityUnitsConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CapacityUnitsConfigurationTypeDef
def get_value() -> CapacityUnitsConfigurationTypeDef:
return {
"StorageCapacityUnits": ...,
"QueryCapacityUnits": ...,
}
Definition
class CapacityUnitsConfigurationTypeDef(TypedDict):
StorageCapacityUnits: int,
QueryCapacityUnits: int,
ClearQuerySuggestionsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ClearQuerySuggestionsRequestRequestTypeDef
def get_value() -> ClearQuerySuggestionsRequestRequestTypeDef:
return {
"IndexId": ...,
}
ClickFeedbackTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ClickFeedbackTypeDef
def get_value() -> ClickFeedbackTypeDef:
return {
"ResultId": ...,
"ClickTime": ...,
}
ConfluenceAttachmentToIndexFieldMappingTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceAttachmentToIndexFieldMappingTypeDef
def get_value() -> ConfluenceAttachmentToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
Definition
class ConfluenceAttachmentToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceAttachmentFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],
ConfluenceBlogToIndexFieldMappingTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceBlogToIndexFieldMappingTypeDef
def get_value() -> ConfluenceBlogToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
Definition
class ConfluenceBlogToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceBlogFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],
ProxyConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ProxyConfigurationTypeDef
def get_value() -> ProxyConfigurationTypeDef:
return {
"Host": ...,
"Port": ...,
}
Definition
class ProxyConfigurationTypeDef(TypedDict):
Host: str,
Port: int,
Credentials: NotRequired[str],
ConfluencePageToIndexFieldMappingTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluencePageToIndexFieldMappingTypeDef
def get_value() -> ConfluencePageToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
Definition
class ConfluencePageToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluencePageFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],
ConfluenceSpaceToIndexFieldMappingTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceSpaceToIndexFieldMappingTypeDef
def get_value() -> ConfluenceSpaceToIndexFieldMappingTypeDef:
return {
"DataSourceFieldName": ...,
}
Definition
class ConfluenceSpaceToIndexFieldMappingTypeDef(TypedDict):
DataSourceFieldName: NotRequired[ConfluenceSpaceFieldNameType], # (1)
DateFieldFormat: NotRequired[str],
IndexFieldName: NotRequired[str],
ConnectionConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConnectionConfigurationTypeDef
def get_value() -> ConnectionConfigurationTypeDef:
return {
"DatabaseHost": ...,
"DatabasePort": ...,
"DatabaseName": ...,
"TableName": ...,
"SecretArn": ...,
}
Definition
class ConnectionConfigurationTypeDef(TypedDict):
DatabaseHost: str,
DatabasePort: int,
DatabaseName: str,
TableName: str,
SecretArn: str,
ContentSourceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ContentSourceConfigurationTypeDef
def get_value() -> ContentSourceConfigurationTypeDef:
return {
"DataSourceIds": ...,
}
Definition
class ContentSourceConfigurationTypeDef(TypedDict):
DataSourceIds: NotRequired[Sequence[str]],
FaqIds: NotRequired[Sequence[str]],
DirectPutContent: NotRequired[bool],
CorrectionTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CorrectionTypeDef
def get_value() -> CorrectionTypeDef:
return {
"BeginOffset": ...,
}
Definition
class CorrectionTypeDef(TypedDict):
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
Term: NotRequired[str],
CorrectedTerm: NotRequired[str],
PrincipalTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import PrincipalTypeDef
def get_value() -> PrincipalTypeDef:
return {
"Name": ...,
"Type": ...,
"Access": ...,
}
Definition
class PrincipalTypeDef(TypedDict):
Name: str,
Type: PrincipalTypeType, # (1)
Access: ReadAccessTypeType, # (2)
DataSourceId: NotRequired[str],
- See PrincipalTypeType
- See ReadAccessTypeType
TagTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
ServerSideEncryptionConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ServerSideEncryptionConfigurationTypeDef
def get_value() -> ServerSideEncryptionConfigurationTypeDef:
return {
"KmsKeyId": ...,
}
UserGroupResolutionConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UserGroupResolutionConfigurationTypeDef
def get_value() -> UserGroupResolutionConfigurationTypeDef:
return {
"UserGroupResolutionMode": ...,
}
Definition
class UserGroupResolutionConfigurationTypeDef(TypedDict):
UserGroupResolutionMode: UserGroupResolutionModeType, # (1)
TemplateConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TemplateConfigurationTypeDef
def get_value() -> TemplateConfigurationTypeDef:
return {
"Template": ...,
}
DataSourceGroupTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceGroupTypeDef
def get_value() -> DataSourceGroupTypeDef:
return {
"GroupId": ...,
"DataSourceId": ...,
}
DataSourceSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceSummaryTypeDef
def get_value() -> DataSourceSummaryTypeDef:
return {
"Name": ...,
}
Definition
class DataSourceSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
Type: NotRequired[DataSourceTypeType], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
Status: NotRequired[DataSourceStatusType], # (2)
LanguageCode: NotRequired[str],
DataSourceSyncJobMetricsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceSyncJobMetricsTypeDef
def get_value() -> DataSourceSyncJobMetricsTypeDef:
return {
"DocumentsAdded": ...,
}
Definition
class DataSourceSyncJobMetricsTypeDef(TypedDict):
DocumentsAdded: NotRequired[str],
DocumentsModified: NotRequired[str],
DocumentsDeleted: NotRequired[str],
DocumentsFailed: NotRequired[str],
DocumentsScanned: NotRequired[str],
SqlConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SqlConfigurationTypeDef
def get_value() -> SqlConfigurationTypeDef:
return {
"QueryIdentifiersEnclosingOption": ...,
}
Definition
class SqlConfigurationTypeDef(TypedDict):
QueryIdentifiersEnclosingOption: NotRequired[QueryIdentifiersEnclosingOptionType], # (1)
DeleteAccessControlConfigurationRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteAccessControlConfigurationRequestRequestTypeDef
def get_value() -> DeleteAccessControlConfigurationRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class DeleteAccessControlConfigurationRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
DeleteDataSourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteDataSourceRequestRequestTypeDef
def get_value() -> DeleteDataSourceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DeleteExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteExperienceRequestRequestTypeDef
def get_value() -> DeleteExperienceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DeleteFaqRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteFaqRequestRequestTypeDef
def get_value() -> DeleteFaqRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DeleteIndexRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteIndexRequestRequestTypeDef
def get_value() -> DeleteIndexRequestRequestTypeDef:
return {
"Id": ...,
}
DeletePrincipalMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeletePrincipalMappingRequestRequestTypeDef
def get_value() -> DeletePrincipalMappingRequestRequestTypeDef:
return {
"IndexId": ...,
"GroupId": ...,
}
Definition
class DeletePrincipalMappingRequestRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
DataSourceId: NotRequired[str],
OrderingId: NotRequired[int],
DeleteQuerySuggestionsBlockListRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteQuerySuggestionsBlockListRequestRequestTypeDef
def get_value() -> DeleteQuerySuggestionsBlockListRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class DeleteQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
DeleteThesaurusRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DeleteThesaurusRequestRequestTypeDef
def get_value() -> DeleteThesaurusRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DescribeAccessControlConfigurationRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeAccessControlConfigurationRequestRequestTypeDef
def get_value() -> DescribeAccessControlConfigurationRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class DescribeAccessControlConfigurationRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
DescribeDataSourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeDataSourceRequestRequestTypeDef
def get_value() -> DescribeDataSourceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DescribeExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeExperienceRequestRequestTypeDef
def get_value() -> DescribeExperienceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
ExperienceEndpointTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ExperienceEndpointTypeDef
def get_value() -> ExperienceEndpointTypeDef:
return {
"EndpointType": ...,
}
Definition
class ExperienceEndpointTypeDef(TypedDict):
EndpointType: NotRequired[EndpointTypeType], # (1)
Endpoint: NotRequired[str],
- See EndpointTypeType
DescribeFaqRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeFaqRequestRequestTypeDef
def get_value() -> DescribeFaqRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DescribeIndexRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeIndexRequestRequestTypeDef
def get_value() -> DescribeIndexRequestRequestTypeDef:
return {
"Id": ...,
}
DescribePrincipalMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribePrincipalMappingRequestRequestTypeDef
def get_value() -> DescribePrincipalMappingRequestRequestTypeDef:
return {
"IndexId": ...,
"GroupId": ...,
}
Definition
class DescribePrincipalMappingRequestRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
DataSourceId: NotRequired[str],
GroupOrderingIdSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GroupOrderingIdSummaryTypeDef
def get_value() -> GroupOrderingIdSummaryTypeDef:
return {
"Status": ...,
}
Definition
class GroupOrderingIdSummaryTypeDef(TypedDict):
Status: NotRequired[PrincipalMappingStatusType], # (1)
LastUpdatedAt: NotRequired[datetime],
ReceivedAt: NotRequired[datetime],
OrderingId: NotRequired[int],
FailureReason: NotRequired[str],
DescribeQuerySuggestionsBlockListRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeQuerySuggestionsBlockListRequestRequestTypeDef
def get_value() -> DescribeQuerySuggestionsBlockListRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class DescribeQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
DescribeQuerySuggestionsConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeQuerySuggestionsConfigRequestRequestTypeDef
def get_value() -> DescribeQuerySuggestionsConfigRequestRequestTypeDef:
return {
"IndexId": ...,
}
DescribeThesaurusRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeThesaurusRequestRequestTypeDef
def get_value() -> DescribeThesaurusRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
DisassociatePersonasFromEntitiesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DisassociatePersonasFromEntitiesRequestRequestTypeDef
def get_value() -> DisassociatePersonasFromEntitiesRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
"EntityIds": ...,
}
Definition
class DisassociatePersonasFromEntitiesRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityIds: Sequence[str],
DocumentAttributeValueTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentAttributeValueTypeDef
def get_value() -> DocumentAttributeValueTypeDef:
return {
"StringValue": ...,
}
Definition
class DocumentAttributeValueTypeDef(TypedDict):
StringValue: NotRequired[str],
StringListValue: NotRequired[Sequence[str]],
LongValue: NotRequired[int],
DateValue: NotRequired[Union[datetime, str]],
RelevanceTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import RelevanceTypeDef
def get_value() -> RelevanceTypeDef:
return {
"Freshness": ...,
}
Definition
class RelevanceTypeDef(TypedDict):
Freshness: NotRequired[bool],
Importance: NotRequired[int],
Duration: NotRequired[str],
RankOrder: NotRequired[OrderType], # (1)
ValueImportanceMap: NotRequired[Dict[str, int]],
- See OrderType
SearchTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SearchTypeDef
def get_value() -> SearchTypeDef:
return {
"Facetable": ...,
}
Definition
class SearchTypeDef(TypedDict):
Facetable: NotRequired[bool],
Searchable: NotRequired[bool],
Displayable: NotRequired[bool],
Sortable: NotRequired[bool],
DocumentsMetadataConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentsMetadataConfigurationTypeDef
def get_value() -> DocumentsMetadataConfigurationTypeDef:
return {
"S3Prefix": ...,
}
EntityDisplayDataTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import EntityDisplayDataTypeDef
def get_value() -> EntityDisplayDataTypeDef:
return {
"UserName": ...,
}
Definition
class EntityDisplayDataTypeDef(TypedDict):
UserName: NotRequired[str],
GroupName: NotRequired[str],
IdentifiedUserName: NotRequired[str],
FirstName: NotRequired[str],
LastName: NotRequired[str],
UserIdentityConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UserIdentityConfigurationTypeDef
def get_value() -> UserIdentityConfigurationTypeDef:
return {
"IdentityAttributeName": ...,
}
Definition
class UserIdentityConfigurationTypeDef(TypedDict):
IdentityAttributeName: NotRequired[str],
FacetResultTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FacetResultTypeDef
def get_value() -> FacetResultTypeDef:
return {
"DocumentAttributeKey": ...,
}
Definition
class FacetResultTypeDef(TypedDict):
DocumentAttributeKey: NotRequired[str],
DocumentAttributeValueType: NotRequired[DocumentAttributeValueTypeType], # (1)
DocumentAttributeValueCountPairs: NotRequired[List[DocumentAttributeValueCountPairTypeDef]], # (2)
FacetTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FacetTypeDef
def get_value() -> FacetTypeDef:
return {
"DocumentAttributeKey": ...,
}
Definition
class FacetTypeDef(TypedDict):
DocumentAttributeKey: NotRequired[str],
Facets: NotRequired[Sequence[FacetTypeDef]], # (1)
MaxResults: NotRequired[int],
- See FacetTypeDef
FaqStatisticsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FaqStatisticsTypeDef
def get_value() -> FaqStatisticsTypeDef:
return {
"IndexedQuestionAnswersCount": ...,
}
FaqSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FaqSummaryTypeDef
def get_value() -> FaqSummaryTypeDef:
return {
"Id": ...,
}
Definition
class FaqSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[FaqStatusType], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
FileFormat: NotRequired[FaqFileFormatType], # (2)
LanguageCode: NotRequired[str],
- See FaqStatusType
- See FaqFileFormatType
GetQuerySuggestionsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GetQuerySuggestionsRequestRequestTypeDef
def get_value() -> GetQuerySuggestionsRequestRequestTypeDef:
return {
"IndexId": ...,
"QueryText": ...,
}
Definition
class GetQuerySuggestionsRequestRequestTypeDef(TypedDict):
IndexId: str,
QueryText: str,
MaxSuggestionsCount: NotRequired[int],
GetSnapshotsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GetSnapshotsRequestRequestTypeDef
def get_value() -> GetSnapshotsRequestRequestTypeDef:
return {
"IndexId": ...,
"Interval": ...,
"MetricType": ...,
}
Definition
class GetSnapshotsRequestRequestTypeDef(TypedDict):
IndexId: str,
Interval: IntervalType, # (1)
MetricType: MetricTypeType, # (2)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See IntervalType
- See MetricTypeType
TimeRangeTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TimeRangeTypeDef
def get_value() -> TimeRangeTypeDef:
return {
"StartTime": ...,
}
Definition
class TimeRangeTypeDef(TypedDict):
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
GitHubDocumentCrawlPropertiesTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GitHubDocumentCrawlPropertiesTypeDef
def get_value() -> GitHubDocumentCrawlPropertiesTypeDef:
return {
"CrawlRepositoryDocuments": ...,
}
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
Usage Example
from types_aiobotocore_kendra.type_defs import SaaSConfigurationTypeDef
def get_value() -> SaaSConfigurationTypeDef:
return {
"OrganizationName": ...,
"HostUrl": ...,
}
MemberGroupTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import MemberGroupTypeDef
def get_value() -> MemberGroupTypeDef:
return {
"GroupId": ...,
}
MemberUserTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import MemberUserTypeDef
def get_value() -> MemberUserTypeDef:
return {
"UserId": ...,
}
GroupSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GroupSummaryTypeDef
def get_value() -> GroupSummaryTypeDef:
return {
"GroupId": ...,
}
Definition
class GroupSummaryTypeDef(TypedDict):
GroupId: NotRequired[str],
OrderingId: NotRequired[int],
HighlightTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import HighlightTypeDef
def get_value() -> HighlightTypeDef:
return {
"BeginOffset": ...,
"EndOffset": ...,
}
Definition
class HighlightTypeDef(TypedDict):
BeginOffset: int,
EndOffset: int,
TopAnswer: NotRequired[bool],
Type: NotRequired[HighlightTypeType], # (1)
IndexConfigurationSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import IndexConfigurationSummaryTypeDef
def get_value() -> IndexConfigurationSummaryTypeDef:
return {
"CreatedAt": ...,
"UpdatedAt": ...,
"Status": ...,
}
Definition
class IndexConfigurationSummaryTypeDef(TypedDict):
CreatedAt: datetime,
UpdatedAt: datetime,
Status: IndexStatusType, # (2)
Name: NotRequired[str],
Id: NotRequired[str],
Edition: NotRequired[IndexEditionType], # (1)
- See IndexEditionType
- See IndexStatusType
TextDocumentStatisticsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TextDocumentStatisticsTypeDef
def get_value() -> TextDocumentStatisticsTypeDef:
return {
"IndexedTextDocumentsCount": ...,
"IndexedTextBytes": ...,
}
Definition
class TextDocumentStatisticsTypeDef(TypedDict):
IndexedTextDocumentsCount: int,
IndexedTextBytes: int,
JsonTokenTypeConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import JsonTokenTypeConfigurationTypeDef
def get_value() -> JsonTokenTypeConfigurationTypeDef:
return {
"UserNameAttributeField": ...,
"GroupAttributeField": ...,
}
Definition
class JsonTokenTypeConfigurationTypeDef(TypedDict):
UserNameAttributeField: str,
GroupAttributeField: str,
JwtTokenTypeConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import JwtTokenTypeConfigurationTypeDef
def get_value() -> JwtTokenTypeConfigurationTypeDef:
return {
"KeyLocation": ...,
}
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
ListAccessControlConfigurationsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListAccessControlConfigurationsRequestRequestTypeDef
def get_value() -> ListAccessControlConfigurationsRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListAccessControlConfigurationsRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDataSourcesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListDataSourcesRequestRequestTypeDef
def get_value() -> ListDataSourcesRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListDataSourcesRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListEntityPersonasRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListEntityPersonasRequestRequestTypeDef
def get_value() -> ListEntityPersonasRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class ListEntityPersonasRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PersonasSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import PersonasSummaryTypeDef
def get_value() -> PersonasSummaryTypeDef:
return {
"EntityId": ...,
}
Definition
class PersonasSummaryTypeDef(TypedDict):
EntityId: NotRequired[str],
Persona: NotRequired[PersonaType], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
- See PersonaType
ListExperienceEntitiesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListExperienceEntitiesRequestRequestTypeDef
def get_value() -> ListExperienceEntitiesRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class ListExperienceEntitiesRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],
ListExperiencesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListExperiencesRequestRequestTypeDef
def get_value() -> ListExperiencesRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListExperiencesRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListFaqsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListFaqsRequestRequestTypeDef
def get_value() -> ListFaqsRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListFaqsRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListGroupsOlderThanOrderingIdRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListGroupsOlderThanOrderingIdRequestRequestTypeDef
def get_value() -> ListGroupsOlderThanOrderingIdRequestRequestTypeDef:
return {
"IndexId": ...,
"OrderingId": ...,
}
Definition
class ListGroupsOlderThanOrderingIdRequestRequestTypeDef(TypedDict):
IndexId: str,
OrderingId: int,
DataSourceId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIndicesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListIndicesRequestRequestTypeDef
def get_value() -> ListIndicesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListIndicesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListQuerySuggestionsBlockListsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListQuerySuggestionsBlockListsRequestRequestTypeDef
def get_value() -> ListQuerySuggestionsBlockListsRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListQuerySuggestionsBlockListsRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuerySuggestionsBlockListSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import QuerySuggestionsBlockListSummaryTypeDef
def get_value() -> QuerySuggestionsBlockListSummaryTypeDef:
return {
"Id": ...,
}
Definition
class QuerySuggestionsBlockListSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[QuerySuggestionsBlockListStatusType], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
ItemCount: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
ListThesauriRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListThesauriRequestRequestTypeDef
def get_value() -> ListThesauriRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class ListThesauriRequestRequestTypeDef(TypedDict):
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ThesaurusSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ThesaurusSummaryTypeDef
def get_value() -> ThesaurusSummaryTypeDef:
return {
"Id": ...,
}
Definition
class ThesaurusSummaryTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[ThesaurusStatusType], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
SortingConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SortingConfigurationTypeDef
def get_value() -> SortingConfigurationTypeDef:
return {
"DocumentAttributeKey": ...,
"SortOrder": ...,
}
Definition
class SortingConfigurationTypeDef(TypedDict):
DocumentAttributeKey: str,
SortOrder: SortOrderType, # (1)
- See SortOrderType
SpellCorrectionConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SpellCorrectionConfigurationTypeDef
def get_value() -> SpellCorrectionConfigurationTypeDef:
return {
"IncludeQuerySpellCheckSuggestions": ...,
}
Definition
class SpellCorrectionConfigurationTypeDef(TypedDict):
IncludeQuerySpellCheckSuggestions: bool,
ScoreAttributesTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ScoreAttributesTypeDef
def get_value() -> ScoreAttributesTypeDef:
return {
"ScoreConfidence": ...,
}
Definition
class ScoreAttributesTypeDef(TypedDict):
ScoreConfidence: NotRequired[ScoreConfidenceType], # (1)
WarningTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import WarningTypeDef
def get_value() -> WarningTypeDef:
return {
"Message": ...,
}
Definition
class WarningTypeDef(TypedDict):
Message: NotRequired[str],
Code: NotRequired[WarningCodeType], # (1)
- See WarningCodeType
RelevanceFeedbackTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import RelevanceFeedbackTypeDef
def get_value() -> RelevanceFeedbackTypeDef:
return {
"ResultId": ...,
"RelevanceValue": ...,
}
Definition
class RelevanceFeedbackTypeDef(TypedDict):
ResultId: str,
RelevanceValue: RelevanceTypeType, # (1)
SeedUrlConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SeedUrlConfigurationTypeDef
def get_value() -> SeedUrlConfigurationTypeDef:
return {
"SeedUrls": ...,
}
Definition
class SeedUrlConfigurationTypeDef(TypedDict):
SeedUrls: Sequence[str],
WebCrawlerMode: NotRequired[WebCrawlerModeType], # (1)
SiteMapsConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SiteMapsConfigurationTypeDef
def get_value() -> SiteMapsConfigurationTypeDef:
return {
"SiteMaps": ...,
}
StartDataSourceSyncJobRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import StartDataSourceSyncJobRequestRequestTypeDef
def get_value() -> StartDataSourceSyncJobRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
StopDataSourceSyncJobRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import StopDataSourceSyncJobRequestRequestTypeDef
def get_value() -> StopDataSourceSyncJobRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
SuggestionHighlightTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SuggestionHighlightTypeDef
def get_value() -> SuggestionHighlightTypeDef:
return {
"BeginOffset": ...,
}
Definition
class SuggestionHighlightTypeDef(TypedDict):
BeginOffset: NotRequired[int],
EndOffset: NotRequired[int],
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateQuerySuggestionsConfigRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateQuerySuggestionsConfigRequestRequestTypeDef
def get_value() -> UpdateQuerySuggestionsConfigRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class UpdateQuerySuggestionsConfigRequestRequestTypeDef(TypedDict):
IndexId: str,
Mode: NotRequired[ModeType], # (1)
QueryLogLookBackWindowInDays: NotRequired[int],
IncludeQueriesWithoutUserInformation: NotRequired[bool],
MinimumNumberOfQueryingUsers: NotRequired[int],
MinimumQueryCount: NotRequired[int],
- See ModeType
ColumnConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ColumnConfigurationTypeDef
def get_value() -> ColumnConfigurationTypeDef:
return {
"DocumentIdColumnName": ...,
"DocumentDataColumnName": ...,
"ChangeDetectingColumns": ...,
}
Definition
class ColumnConfigurationTypeDef(TypedDict):
DocumentIdColumnName: str,
DocumentDataColumnName: str,
ChangeDetectingColumns: Sequence[str],
DocumentTitleColumnName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
GoogleDriveConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GoogleDriveConfigurationTypeDef
def get_value() -> GoogleDriveConfigurationTypeDef:
return {
"SecretArn": ...,
}
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]],
SalesforceChatterFeedConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceChatterFeedConfigurationTypeDef
def get_value() -> SalesforceChatterFeedConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
Definition
class SalesforceChatterFeedConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
IncludeFilterTypes: NotRequired[Sequence[SalesforceChatterFeedIncludeFilterTypeType]], # (2)
SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
def get_value() -> SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef:
return {
"Name": ...,
"DocumentDataFieldName": ...,
}
Definition
class SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
Name: str,
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
def get_value() -> SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
Definition
class SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
SalesforceStandardObjectAttachmentConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceStandardObjectAttachmentConfigurationTypeDef
def get_value() -> SalesforceStandardObjectAttachmentConfigurationTypeDef:
return {
"DocumentTitleFieldName": ...,
}
Definition
class SalesforceStandardObjectAttachmentConfigurationTypeDef(TypedDict):
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (1)
SalesforceStandardObjectConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceStandardObjectConfigurationTypeDef
def get_value() -> SalesforceStandardObjectConfigurationTypeDef:
return {
"Name": ...,
"DocumentDataFieldName": ...,
}
Definition
class SalesforceStandardObjectConfigurationTypeDef(TypedDict):
Name: SalesforceStandardObjectNameType, # (1)
DocumentDataFieldName: str,
DocumentTitleFieldName: NotRequired[str],
FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]], # (2)
ServiceNowKnowledgeArticleConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ServiceNowKnowledgeArticleConfigurationTypeDef
def get_value() -> ServiceNowKnowledgeArticleConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
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],
ServiceNowServiceCatalogConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ServiceNowServiceCatalogConfigurationTypeDef
def get_value() -> ServiceNowServiceCatalogConfigurationTypeDef:
return {
"DocumentDataFieldName": ...,
}
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)
WorkDocsConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import WorkDocsConfigurationTypeDef
def get_value() -> WorkDocsConfigurationTypeDef:
return {
"OrganizationId": ...,
}
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)
BoxConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BoxConfigurationTypeDef
def get_value() -> BoxConfigurationTypeDef:
return {
"EnterpriseId": ...,
"SecretArn": ...,
}
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 DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceVpcConfigurationTypeDef
FsxConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import FsxConfigurationTypeDef
def get_value() -> FsxConfigurationTypeDef:
return {
"FileSystemId": ...,
"FileSystemType": ...,
"VpcConfiguration": ...,
}
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 DataSourceToIndexFieldMappingTypeDef
JiraConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import JiraConfigurationTypeDef
def get_value() -> JiraConfigurationTypeDef:
return {
"JiraAccountUrl": ...,
"SecretArn": ...,
}
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 IssueSubEntityType
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceVpcConfigurationTypeDef
QuipConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import QuipConfigurationTypeDef
def get_value() -> QuipConfigurationTypeDef:
return {
"Domain": ...,
"SecretArn": ...,
}
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 DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceVpcConfigurationTypeDef
SlackConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SlackConfigurationTypeDef
def get_value() -> SlackConfigurationTypeDef:
return {
"TeamId": ...,
"SecretArn": ...,
"SlackEntityList": ...,
"SinceCrawlDate": ...,
}
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)
AlfrescoConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AlfrescoConfigurationTypeDef
def get_value() -> AlfrescoConfigurationTypeDef:
return {
"SiteUrl": ...,
"SiteId": ...,
"SecretArn": ...,
"SslCertificateS3Path": ...,
}
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 AlfrescoEntityType
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceVpcConfigurationTypeDef
OnPremiseConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import OnPremiseConfigurationTypeDef
def get_value() -> OnPremiseConfigurationTypeDef:
return {
"HostUrl": ...,
"OrganizationName": ...,
"SslCertificateS3Path": ...,
}
Definition
class OnPremiseConfigurationTypeDef(TypedDict):
HostUrl: str,
OrganizationName: str,
SslCertificateS3Path: S3PathTypeDef, # (1)
- See S3PathTypeDef
OneDriveUsersTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import OneDriveUsersTypeDef
def get_value() -> OneDriveUsersTypeDef:
return {
"OneDriveUserList": ...,
}
Definition
class OneDriveUsersTypeDef(TypedDict):
OneDriveUserList: NotRequired[Sequence[str]],
OneDriveUserS3Path: NotRequired[S3PathTypeDef], # (1)
- See S3PathTypeDef
UpdateQuerySuggestionsBlockListRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateQuerySuggestionsBlockListRequestRequestTypeDef
def get_value() -> UpdateQuerySuggestionsBlockListRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class UpdateQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: NotRequired[str],
Description: NotRequired[str],
SourceS3Path: NotRequired[S3PathTypeDef], # (1)
RoleArn: NotRequired[str],
- See S3PathTypeDef
UpdateThesaurusRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateThesaurusRequestRequestTypeDef
def get_value() -> UpdateThesaurusRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class UpdateThesaurusRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
Description: NotRequired[str],
RoleArn: NotRequired[str],
SourceS3Path: NotRequired[S3PathTypeDef], # (1)
- See S3PathTypeDef
AssociateEntitiesToExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AssociateEntitiesToExperienceRequestRequestTypeDef
def get_value() -> AssociateEntitiesToExperienceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
"EntityList": ...,
}
Definition
class AssociateEntitiesToExperienceRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)
DisassociateEntitiesFromExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DisassociateEntitiesFromExperienceRequestRequestTypeDef
def get_value() -> DisassociateEntitiesFromExperienceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
"EntityList": ...,
}
Definition
class DisassociateEntitiesFromExperienceRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)
AssociateEntitiesToExperienceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AssociateEntitiesToExperienceResponseTypeDef
def get_value() -> AssociateEntitiesToExperienceResponseTypeDef:
return {
"FailedEntityList": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateEntitiesToExperienceResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociatePersonasToEntitiesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AssociatePersonasToEntitiesResponseTypeDef
def get_value() -> AssociatePersonasToEntitiesResponseTypeDef:
return {
"FailedEntityList": ...,
"ResponseMetadata": ...,
}
Definition
class AssociatePersonasToEntitiesResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAccessControlConfigurationResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateAccessControlConfigurationResponseTypeDef
def get_value() -> CreateAccessControlConfigurationResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAccessControlConfigurationResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDataSourceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateDataSourceResponseTypeDef
def get_value() -> CreateDataSourceResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDataSourceResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateExperienceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateExperienceResponseTypeDef
def get_value() -> CreateExperienceResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateExperienceResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFaqResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateFaqResponseTypeDef
def get_value() -> CreateFaqResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateFaqResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIndexResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateIndexResponseTypeDef
def get_value() -> CreateIndexResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateIndexResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateQuerySuggestionsBlockListResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateQuerySuggestionsBlockListResponseTypeDef
def get_value() -> CreateQuerySuggestionsBlockListResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateQuerySuggestionsBlockListResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThesaurusResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateThesaurusResponseTypeDef
def get_value() -> CreateThesaurusResponseTypeDef:
return {
"Id": ...,
"ResponseMetadata": ...,
}
Definition
class CreateThesaurusResponseTypeDef(TypedDict):
Id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeFaqResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeFaqResponseTypeDef
def get_value() -> DescribeFaqResponseTypeDef:
return {
"Id": ...,
"IndexId": ...,
"Name": ...,
"Description": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"S3Path": ...,
"Status": ...,
"RoleArn": ...,
"ErrorMessage": ...,
"FileFormat": ...,
"LanguageCode": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeFaqResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Description: str,
CreatedAt: datetime,
UpdatedAt: 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
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeQuerySuggestionsBlockListResponseTypeDef
def get_value() -> DescribeQuerySuggestionsBlockListResponseTypeDef:
return {
"IndexId": ...,
"Id": ...,
"Name": ...,
"Description": ...,
"Status": ...,
"ErrorMessage": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"SourceS3Path": ...,
"ItemCount": ...,
"FileSizeBytes": ...,
"RoleArn": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeQuerySuggestionsBlockListResponseTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: str,
Description: str,
Status: QuerySuggestionsBlockListStatusType, # (1)
ErrorMessage: str,
CreatedAt: datetime,
UpdatedAt: datetime,
SourceS3Path: S3PathTypeDef, # (2)
ItemCount: int,
FileSizeBytes: int,
RoleArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeQuerySuggestionsConfigResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeQuerySuggestionsConfigResponseTypeDef
def get_value() -> DescribeQuerySuggestionsConfigResponseTypeDef:
return {
"Mode": ...,
"Status": ...,
"QueryLogLookBackWindowInDays": ...,
"IncludeQueriesWithoutUserInformation": ...,
"MinimumNumberOfQueryingUsers": ...,
"MinimumQueryCount": ...,
"LastSuggestionsBuildTime": ...,
"LastClearTime": ...,
"TotalSuggestionsCount": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeQuerySuggestionsConfigResponseTypeDef(TypedDict):
Mode: ModeType, # (1)
Status: QuerySuggestionsStatusType, # (2)
QueryLogLookBackWindowInDays: int,
IncludeQueriesWithoutUserInformation: bool,
MinimumNumberOfQueryingUsers: int,
MinimumQueryCount: int,
LastSuggestionsBuildTime: datetime,
LastClearTime: datetime,
TotalSuggestionsCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeThesaurusResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeThesaurusResponseTypeDef
def get_value() -> DescribeThesaurusResponseTypeDef:
return {
"Id": ...,
"IndexId": ...,
"Name": ...,
"Description": ...,
"Status": ...,
"ErrorMessage": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"RoleArn": ...,
"SourceS3Path": ...,
"FileSizeBytes": ...,
"TermCount": ...,
"SynonymRuleCount": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeThesaurusResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Description: str,
Status: ThesaurusStatusType, # (1)
ErrorMessage: str,
CreatedAt: datetime,
UpdatedAt: datetime,
RoleArn: str,
SourceS3Path: S3PathTypeDef, # (2)
FileSizeBytes: int,
TermCount: int,
SynonymRuleCount: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ThesaurusStatusType
- See S3PathTypeDef
- See ResponseMetadataTypeDef
DisassociateEntitiesFromExperienceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DisassociateEntitiesFromExperienceResponseTypeDef
def get_value() -> DisassociateEntitiesFromExperienceResponseTypeDef:
return {
"FailedEntityList": ...,
"ResponseMetadata": ...,
}
Definition
class DisassociateEntitiesFromExperienceResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociatePersonasFromEntitiesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DisassociatePersonasFromEntitiesResponseTypeDef
def get_value() -> DisassociatePersonasFromEntitiesResponseTypeDef:
return {
"FailedEntityList": ...,
"ResponseMetadata": ...,
}
Definition
class DisassociatePersonasFromEntitiesResponseTypeDef(TypedDict):
FailedEntityList: List[FailedEntityTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAccessControlConfigurationsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListAccessControlConfigurationsResponseTypeDef
def get_value() -> ListAccessControlConfigurationsResponseTypeDef:
return {
"NextToken": ...,
"AccessControlConfigurations": ...,
"ResponseMetadata": ...,
}
Definition
class ListAccessControlConfigurationsResponseTypeDef(TypedDict):
NextToken: str,
AccessControlConfigurations: List[AccessControlConfigurationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartDataSourceSyncJobResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import StartDataSourceSyncJobResponseTypeDef
def get_value() -> StartDataSourceSyncJobResponseTypeDef:
return {
"ExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class StartDataSourceSyncJobResponseTypeDef(TypedDict):
ExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AssociatePersonasToEntitiesRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AssociatePersonasToEntitiesRequestRequestTypeDef
def get_value() -> AssociatePersonasToEntitiesRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
"Personas": ...,
}
Definition
class AssociatePersonasToEntitiesRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Personas: Sequence[EntityPersonaConfigurationTypeDef], # (1)
AuthenticationConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AuthenticationConfigurationTypeDef
def get_value() -> AuthenticationConfigurationTypeDef:
return {
"BasicAuthentication": ...,
}
Definition
class AuthenticationConfigurationTypeDef(TypedDict):
BasicAuthentication: NotRequired[Sequence[BasicAuthenticationConfigurationTypeDef]], # (1)
BatchDeleteDocumentRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchDeleteDocumentRequestRequestTypeDef
def get_value() -> BatchDeleteDocumentRequestRequestTypeDef:
return {
"IndexId": ...,
"DocumentIdList": ...,
}
Definition
class BatchDeleteDocumentRequestRequestTypeDef(TypedDict):
IndexId: str,
DocumentIdList: Sequence[str],
DataSourceSyncJobMetricTarget: NotRequired[DataSourceSyncJobMetricTargetTypeDef], # (1)
BatchDeleteDocumentResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchDeleteDocumentResponseTypeDef
def get_value() -> BatchDeleteDocumentResponseTypeDef:
return {
"FailedDocuments": ...,
"ResponseMetadata": ...,
}
Definition
class BatchDeleteDocumentResponseTypeDef(TypedDict):
FailedDocuments: List[BatchDeleteDocumentResponseFailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetDocumentStatusResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchGetDocumentStatusResponseTypeDef
def get_value() -> BatchGetDocumentStatusResponseTypeDef:
return {
"Errors": ...,
"DocumentStatusList": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetDocumentStatusResponseTypeDef(TypedDict):
Errors: List[BatchGetDocumentStatusResponseErrorTypeDef], # (1)
DocumentStatusList: List[StatusTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchPutDocumentResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchPutDocumentResponseTypeDef
def get_value() -> BatchPutDocumentResponseTypeDef:
return {
"FailedDocuments": ...,
"ResponseMetadata": ...,
}
Definition
class BatchPutDocumentResponseTypeDef(TypedDict):
FailedDocuments: List[BatchPutDocumentResponseFailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConfluenceAttachmentConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceAttachmentConfigurationTypeDef
def get_value() -> ConfluenceAttachmentConfigurationTypeDef:
return {
"CrawlAttachments": ...,
}
Definition
class ConfluenceAttachmentConfigurationTypeDef(TypedDict):
CrawlAttachments: NotRequired[bool],
AttachmentFieldMappings: NotRequired[Sequence[ConfluenceAttachmentToIndexFieldMappingTypeDef]], # (1)
ConfluenceBlogConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceBlogConfigurationTypeDef
def get_value() -> ConfluenceBlogConfigurationTypeDef:
return {
"BlogFieldMappings": ...,
}
Definition
class ConfluenceBlogConfigurationTypeDef(TypedDict):
BlogFieldMappings: NotRequired[Sequence[ConfluenceBlogToIndexFieldMappingTypeDef]], # (1)
SharePointConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SharePointConfigurationTypeDef
def get_value() -> SharePointConfigurationTypeDef:
return {
"SharePointVersion": ...,
"Urls": ...,
"SecretArn": ...,
}
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 DataSourceToIndexFieldMappingTypeDef
- See S3PathTypeDef
- See SharePointOnlineAuthenticationTypeType
- See ProxyConfigurationTypeDef
ConfluencePageConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluencePageConfigurationTypeDef
def get_value() -> ConfluencePageConfigurationTypeDef:
return {
"PageFieldMappings": ...,
}
Definition
class ConfluencePageConfigurationTypeDef(TypedDict):
PageFieldMappings: NotRequired[Sequence[ConfluencePageToIndexFieldMappingTypeDef]], # (1)
ConfluenceSpaceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceSpaceConfigurationTypeDef
def get_value() -> ConfluenceSpaceConfigurationTypeDef:
return {
"CrawlPersonalSpaces": ...,
}
Definition
class ConfluenceSpaceConfigurationTypeDef(TypedDict):
CrawlPersonalSpaces: NotRequired[bool],
CrawlArchivedSpaces: NotRequired[bool],
IncludeSpaces: NotRequired[Sequence[str]],
ExcludeSpaces: NotRequired[Sequence[str]],
SpaceFieldMappings: NotRequired[Sequence[ConfluenceSpaceToIndexFieldMappingTypeDef]], # (1)
SpellCorrectedQueryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SpellCorrectedQueryTypeDef
def get_value() -> SpellCorrectedQueryTypeDef:
return {
"SuggestedQueryText": ...,
}
Definition
class SpellCorrectedQueryTypeDef(TypedDict):
SuggestedQueryText: NotRequired[str],
Corrections: NotRequired[List[CorrectionTypeDef]], # (1)
HierarchicalPrincipalTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import HierarchicalPrincipalTypeDef
def get_value() -> HierarchicalPrincipalTypeDef:
return {
"PrincipalList": ...,
}
Definition
class HierarchicalPrincipalTypeDef(TypedDict):
PrincipalList: Sequence[PrincipalTypeDef], # (1)
- See PrincipalTypeDef
CreateFaqRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateFaqRequestRequestTypeDef
def get_value() -> CreateFaqRequestRequestTypeDef:
return {
"IndexId": ...,
"Name": ...,
"S3Path": ...,
"RoleArn": ...,
}
Definition
class CreateFaqRequestRequestTypeDef(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 TagTypeDef
- See FaqFileFormatType
CreateQuerySuggestionsBlockListRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateQuerySuggestionsBlockListRequestRequestTypeDef
def get_value() -> CreateQuerySuggestionsBlockListRequestRequestTypeDef:
return {
"IndexId": ...,
"Name": ...,
"SourceS3Path": ...,
"RoleArn": ...,
}
Definition
class CreateQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
SourceS3Path: S3PathTypeDef, # (1)
RoleArn: str,
Description: NotRequired[str],
ClientToken: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See S3PathTypeDef
- See TagTypeDef
CreateThesaurusRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateThesaurusRequestRequestTypeDef
def get_value() -> CreateThesaurusRequestRequestTypeDef:
return {
"IndexId": ...,
"Name": ...,
"RoleArn": ...,
"SourceS3Path": ...,
}
Definition
class CreateThesaurusRequestRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
RoleArn: str,
SourceS3Path: S3PathTypeDef, # (1)
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ClientToken: NotRequired[str],
- See S3PathTypeDef
- See TagTypeDef
ListTagsForResourceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
UserContextTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UserContextTypeDef
def get_value() -> UserContextTypeDef:
return {
"Token": ...,
}
Definition
class UserContextTypeDef(TypedDict):
Token: NotRequired[str],
UserId: NotRequired[str],
Groups: NotRequired[Sequence[str]],
DataSourceGroups: NotRequired[Sequence[DataSourceGroupTypeDef]], # (1)
ListDataSourcesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListDataSourcesResponseTypeDef
def get_value() -> ListDataSourcesResponseTypeDef:
return {
"SummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDataSourcesResponseTypeDef(TypedDict):
SummaryItems: List[DataSourceSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DataSourceSyncJobTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceSyncJobTypeDef
def get_value() -> DataSourceSyncJobTypeDef:
return {
"ExecutionId": ...,
}
Definition
class DataSourceSyncJobTypeDef(TypedDict):
ExecutionId: NotRequired[str],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
Status: NotRequired[DataSourceSyncJobStatusType], # (1)
ErrorMessage: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (2)
DataSourceErrorCode: NotRequired[str],
Metrics: NotRequired[DataSourceSyncJobMetricsTypeDef], # (3)
ExperiencesSummaryTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ExperiencesSummaryTypeDef
def get_value() -> ExperiencesSummaryTypeDef:
return {
"Name": ...,
}
Definition
class ExperiencesSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
CreatedAt: NotRequired[datetime],
Status: NotRequired[ExperienceStatusType], # (1)
Endpoints: NotRequired[List[ExperienceEndpointTypeDef]], # (2)
DescribePrincipalMappingResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribePrincipalMappingResponseTypeDef
def get_value() -> DescribePrincipalMappingResponseTypeDef:
return {
"IndexId": ...,
"DataSourceId": ...,
"GroupId": ...,
"GroupOrderingIdSummaries": ...,
"ResponseMetadata": ...,
}
Definition
class DescribePrincipalMappingResponseTypeDef(TypedDict):
IndexId: str,
DataSourceId: str,
GroupId: str,
GroupOrderingIdSummaries: List[GroupOrderingIdSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentAttributeConditionTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentAttributeConditionTypeDef
def get_value() -> DocumentAttributeConditionTypeDef:
return {
"ConditionDocumentAttributeKey": ...,
"Operator": ...,
}
Definition
class DocumentAttributeConditionTypeDef(TypedDict):
ConditionDocumentAttributeKey: str,
Operator: ConditionOperatorType, # (1)
ConditionOnValue: NotRequired[DocumentAttributeValueTypeDef], # (2)
DocumentAttributeTargetTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentAttributeTargetTypeDef
def get_value() -> DocumentAttributeTargetTypeDef:
return {
"TargetDocumentAttributeKey": ...,
}
Definition
class DocumentAttributeTargetTypeDef(TypedDict):
TargetDocumentAttributeKey: NotRequired[str],
TargetDocumentAttributeValueDeletion: NotRequired[bool],
TargetDocumentAttributeValue: NotRequired[DocumentAttributeValueTypeDef], # (1)
DocumentAttributeTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentAttributeTypeDef
def get_value() -> DocumentAttributeTypeDef:
return {
"Key": ...,
"Value": ...,
}
Definition
class DocumentAttributeTypeDef(TypedDict):
Key: str,
Value: DocumentAttributeValueTypeDef, # (1)
DocumentAttributeValueCountPairTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentAttributeValueCountPairTypeDef
def get_value() -> DocumentAttributeValueCountPairTypeDef:
return {
"DocumentAttributeValue": ...,
}
Definition
class DocumentAttributeValueCountPairTypeDef(TypedDict):
DocumentAttributeValue: NotRequired[DocumentAttributeValueTypeDef], # (1)
Count: NotRequired[int],
FacetResults: NotRequired[List[FacetResultTypeDef]], # (2)
DocumentRelevanceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentRelevanceConfigurationTypeDef
def get_value() -> DocumentRelevanceConfigurationTypeDef:
return {
"Name": ...,
"Relevance": ...,
}
Definition
class DocumentRelevanceConfigurationTypeDef(TypedDict):
Name: str,
Relevance: RelevanceTypeDef, # (1)
- See RelevanceTypeDef
DocumentMetadataConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentMetadataConfigurationTypeDef
def get_value() -> DocumentMetadataConfigurationTypeDef:
return {
"Name": ...,
"Type": ...,
}
Definition
class DocumentMetadataConfigurationTypeDef(TypedDict):
Name: str,
Type: DocumentAttributeValueTypeType, # (1)
Relevance: NotRequired[RelevanceTypeDef], # (2)
Search: NotRequired[SearchTypeDef], # (3)
S3DataSourceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import S3DataSourceConfigurationTypeDef
def get_value() -> S3DataSourceConfigurationTypeDef:
return {
"BucketName": ...,
}
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
Usage Example
from types_aiobotocore_kendra.type_defs import ExperienceEntitiesSummaryTypeDef
def get_value() -> ExperienceEntitiesSummaryTypeDef:
return {
"EntityId": ...,
}
Definition
class ExperienceEntitiesSummaryTypeDef(TypedDict):
EntityId: NotRequired[str],
EntityType: NotRequired[EntityTypeType], # (1)
DisplayData: NotRequired[EntityDisplayDataTypeDef], # (2)
ExperienceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ExperienceConfigurationTypeDef
def get_value() -> ExperienceConfigurationTypeDef:
return {
"ContentSourceConfiguration": ...,
}
Definition
class ExperienceConfigurationTypeDef(TypedDict):
ContentSourceConfiguration: NotRequired[ContentSourceConfigurationTypeDef], # (1)
UserIdentityConfiguration: NotRequired[UserIdentityConfigurationTypeDef], # (2)
ListFaqsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListFaqsResponseTypeDef
def get_value() -> ListFaqsResponseTypeDef:
return {
"NextToken": ...,
"FaqSummaryItems": ...,
"ResponseMetadata": ...,
}
Definition
class ListFaqsResponseTypeDef(TypedDict):
NextToken: str,
FaqSummaryItems: List[FaqSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSnapshotsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GetSnapshotsResponseTypeDef
def get_value() -> GetSnapshotsResponseTypeDef:
return {
"SnapShotTimeFilter": ...,
"SnapshotsDataHeader": ...,
"SnapshotsData": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetSnapshotsResponseTypeDef(TypedDict):
SnapShotTimeFilter: TimeRangeTypeDef, # (1)
SnapshotsDataHeader: List[str],
SnapshotsData: List[List[str]],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDataSourceSyncJobsRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListDataSourceSyncJobsRequestRequestTypeDef
def get_value() -> ListDataSourceSyncJobsRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class ListDataSourceSyncJobsRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
StartTimeFilter: NotRequired[TimeRangeTypeDef], # (1)
StatusFilter: NotRequired[DataSourceSyncJobStatusType], # (2)
GroupMembersTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GroupMembersTypeDef
def get_value() -> GroupMembersTypeDef:
return {
"MemberGroups": ...,
}
Definition
class GroupMembersTypeDef(TypedDict):
MemberGroups: NotRequired[Sequence[MemberGroupTypeDef]], # (1)
MemberUsers: NotRequired[Sequence[MemberUserTypeDef]], # (2)
S3PathforGroupMembers: NotRequired[S3PathTypeDef], # (3)
- See MemberGroupTypeDef
- See MemberUserTypeDef
- See S3PathTypeDef
ListGroupsOlderThanOrderingIdResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListGroupsOlderThanOrderingIdResponseTypeDef
def get_value() -> ListGroupsOlderThanOrderingIdResponseTypeDef:
return {
"GroupsSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListGroupsOlderThanOrderingIdResponseTypeDef(TypedDict):
GroupsSummaries: List[GroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TextWithHighlightsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import TextWithHighlightsTypeDef
def get_value() -> TextWithHighlightsTypeDef:
return {
"Text": ...,
}
Definition
class TextWithHighlightsTypeDef(TypedDict):
Text: NotRequired[str],
Highlights: NotRequired[List[HighlightTypeDef]], # (1)
- See HighlightTypeDef
ListIndicesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListIndicesResponseTypeDef
def get_value() -> ListIndicesResponseTypeDef:
return {
"IndexConfigurationSummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListIndicesResponseTypeDef(TypedDict):
IndexConfigurationSummaryItems: List[IndexConfigurationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
IndexStatisticsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import IndexStatisticsTypeDef
def get_value() -> IndexStatisticsTypeDef:
return {
"FaqStatistics": ...,
"TextDocumentStatistics": ...,
}
Definition
class IndexStatisticsTypeDef(TypedDict):
FaqStatistics: FaqStatisticsTypeDef, # (1)
TextDocumentStatistics: TextDocumentStatisticsTypeDef, # (2)
UserTokenConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UserTokenConfigurationTypeDef
def get_value() -> UserTokenConfigurationTypeDef:
return {
"JwtTokenTypeConfiguration": ...,
}
Definition
class UserTokenConfigurationTypeDef(TypedDict):
JwtTokenTypeConfiguration: NotRequired[JwtTokenTypeConfigurationTypeDef], # (1)
JsonTokenTypeConfiguration: NotRequired[JsonTokenTypeConfigurationTypeDef], # (2)
ListEntityPersonasResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListEntityPersonasResponseTypeDef
def get_value() -> ListEntityPersonasResponseTypeDef:
return {
"SummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListEntityPersonasResponseTypeDef(TypedDict):
SummaryItems: List[PersonasSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListQuerySuggestionsBlockListsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListQuerySuggestionsBlockListsResponseTypeDef
def get_value() -> ListQuerySuggestionsBlockListsResponseTypeDef:
return {
"BlockListSummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListQuerySuggestionsBlockListsResponseTypeDef(TypedDict):
BlockListSummaryItems: List[QuerySuggestionsBlockListSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThesauriResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListThesauriResponseTypeDef
def get_value() -> ListThesauriResponseTypeDef:
return {
"NextToken": ...,
"ThesaurusSummaryItems": ...,
"ResponseMetadata": ...,
}
Definition
class ListThesauriResponseTypeDef(TypedDict):
NextToken: str,
ThesaurusSummaryItems: List[ThesaurusSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SubmitFeedbackRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SubmitFeedbackRequestRequestTypeDef
def get_value() -> SubmitFeedbackRequestRequestTypeDef:
return {
"IndexId": ...,
"QueryId": ...,
}
Definition
class SubmitFeedbackRequestRequestTypeDef(TypedDict):
IndexId: str,
QueryId: str,
ClickFeedbackItems: NotRequired[Sequence[ClickFeedbackTypeDef]], # (1)
RelevanceFeedbackItems: NotRequired[Sequence[RelevanceFeedbackTypeDef]], # (2)
UrlsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UrlsTypeDef
def get_value() -> UrlsTypeDef:
return {
"SeedUrlConfiguration": ...,
}
Definition
class UrlsTypeDef(TypedDict):
SeedUrlConfiguration: NotRequired[SeedUrlConfigurationTypeDef], # (1)
SiteMapsConfiguration: NotRequired[SiteMapsConfigurationTypeDef], # (2)
SuggestionTextWithHighlightsTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SuggestionTextWithHighlightsTypeDef
def get_value() -> SuggestionTextWithHighlightsTypeDef:
return {
"Text": ...,
}
Definition
class SuggestionTextWithHighlightsTypeDef(TypedDict):
Text: NotRequired[str],
Highlights: NotRequired[List[SuggestionHighlightTypeDef]], # (1)
DatabaseConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DatabaseConfigurationTypeDef
def get_value() -> DatabaseConfigurationTypeDef:
return {
"DatabaseEngineType": ...,
"ConnectionConfiguration": ...,
"ColumnConfiguration": ...,
}
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
SalesforceKnowledgeArticleConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceKnowledgeArticleConfigurationTypeDef
def get_value() -> SalesforceKnowledgeArticleConfigurationTypeDef:
return {
"IncludedStates": ...,
}
Definition
class SalesforceKnowledgeArticleConfigurationTypeDef(TypedDict):
IncludedStates: Sequence[SalesforceKnowledgeArticleStateType], # (1)
StandardKnowledgeArticleTypeConfiguration: NotRequired[SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef], # (2)
CustomKnowledgeArticleTypeConfigurations: NotRequired[Sequence[SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef]], # (3)
- See SalesforceKnowledgeArticleStateType
- See SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
- See SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
ServiceNowConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ServiceNowConfigurationTypeDef
def get_value() -> ServiceNowConfigurationTypeDef:
return {
"HostUrl": ...,
"SecretArn": ...,
"ServiceNowBuildVersion": ...,
}
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
GitHubConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GitHubConfigurationTypeDef
def get_value() -> GitHubConfigurationTypeDef:
return {
"SecretArn": ...,
}
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 DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
- See DataSourceToIndexFieldMappingTypeDef
OneDriveConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import OneDriveConfigurationTypeDef
def get_value() -> OneDriveConfigurationTypeDef:
return {
"TenantDomain": ...,
"SecretArn": ...,
"OneDriveUsers": ...,
}
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],
ConfluenceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ConfluenceConfigurationTypeDef
def get_value() -> ConfluenceConfigurationTypeDef:
return {
"ServerUrl": ...,
"SecretArn": ...,
"Version": ...,
}
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
CreateAccessControlConfigurationRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateAccessControlConfigurationRequestRequestTypeDef
def get_value() -> CreateAccessControlConfigurationRequestRequestTypeDef:
return {
"IndexId": ...,
"Name": ...,
}
Definition
class CreateAccessControlConfigurationRequestRequestTypeDef(TypedDict):
IndexId: str,
Name: str,
Description: NotRequired[str],
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (1)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalTypeDef]], # (2)
ClientToken: NotRequired[str],
DescribeAccessControlConfigurationResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeAccessControlConfigurationResponseTypeDef
def get_value() -> DescribeAccessControlConfigurationResponseTypeDef:
return {
"Name": ...,
"Description": ...,
"ErrorMessage": ...,
"AccessControlList": ...,
"HierarchicalAccessControlList": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAccessControlConfigurationResponseTypeDef(TypedDict):
Name: str,
Description: str,
ErrorMessage: str,
AccessControlList: List[PrincipalTypeDef], # (1)
HierarchicalAccessControlList: List[HierarchicalPrincipalTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateAccessControlConfigurationRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateAccessControlConfigurationRequestRequestTypeDef
def get_value() -> UpdateAccessControlConfigurationRequestRequestTypeDef:
return {
"IndexId": ...,
"Id": ...,
}
Definition
class UpdateAccessControlConfigurationRequestRequestTypeDef(TypedDict):
IndexId: str,
Id: str,
Name: NotRequired[str],
Description: NotRequired[str],
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (1)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalTypeDef]], # (2)
ListDataSourceSyncJobsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListDataSourceSyncJobsResponseTypeDef
def get_value() -> ListDataSourceSyncJobsResponseTypeDef:
return {
"History": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
History: List[DataSourceSyncJobTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListExperiencesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListExperiencesResponseTypeDef
def get_value() -> ListExperiencesResponseTypeDef:
return {
"SummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListExperiencesResponseTypeDef(TypedDict):
SummaryItems: List[ExperiencesSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
HookConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import HookConfigurationTypeDef
def get_value() -> HookConfigurationTypeDef:
return {
"LambdaArn": ...,
"S3Bucket": ...,
}
Definition
class HookConfigurationTypeDef(TypedDict):
LambdaArn: str,
S3Bucket: str,
InvocationCondition: NotRequired[DocumentAttributeConditionTypeDef], # (1)
InlineCustomDocumentEnrichmentConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import InlineCustomDocumentEnrichmentConfigurationTypeDef
def get_value() -> InlineCustomDocumentEnrichmentConfigurationTypeDef:
return {
"Condition": ...,
}
Definition
class InlineCustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
Condition: NotRequired[DocumentAttributeConditionTypeDef], # (1)
Target: NotRequired[DocumentAttributeTargetTypeDef], # (2)
DocumentContentDeletion: NotRequired[bool],
AttributeFilterTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AttributeFilterTypeDef
def get_value() -> AttributeFilterTypeDef:
return {
"AndAllFilters": ...,
}
Definition
class AttributeFilterTypeDef(TypedDict):
AndAllFilters: NotRequired[Sequence[AttributeFilterTypeDef]], # (1)
OrAllFilters: NotRequired[Sequence[AttributeFilterTypeDef]], # (1)
NotFilter: NotRequired[AttributeFilterTypeDef], # (3)
EqualsTo: NotRequired[DocumentAttributeTypeDef], # (4)
ContainsAll: NotRequired[DocumentAttributeTypeDef], # (4)
ContainsAny: NotRequired[DocumentAttributeTypeDef], # (4)
GreaterThan: NotRequired[DocumentAttributeTypeDef], # (4)
GreaterThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (4)
LessThan: NotRequired[DocumentAttributeTypeDef], # (4)
LessThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (4)
- See AttributeFilterTypeDef
- See AttributeFilterTypeDef
- See AttributeFilterTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
DocumentInfoTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentInfoTypeDef
def get_value() -> DocumentInfoTypeDef:
return {
"DocumentId": ...,
}
Definition
class DocumentInfoTypeDef(TypedDict):
DocumentId: str,
Attributes: NotRequired[Sequence[DocumentAttributeTypeDef]], # (1)
DocumentTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"Id": ...,
}
Definition
class DocumentTypeDef(TypedDict):
Id: str,
Title: NotRequired[str],
Blob: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Path: NotRequired[S3PathTypeDef], # (1)
Attributes: NotRequired[Sequence[DocumentAttributeTypeDef]], # (2)
AccessControlList: NotRequired[Sequence[PrincipalTypeDef]], # (3)
HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalTypeDef]], # (4)
ContentType: NotRequired[ContentTypeType], # (5)
AccessControlConfigurationId: NotRequired[str],
- See S3PathTypeDef
- See DocumentAttributeTypeDef
- See PrincipalTypeDef
- See HierarchicalPrincipalTypeDef
- See ContentTypeType
QueryRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import QueryRequestRequestTypeDef
def get_value() -> QueryRequestRequestTypeDef:
return {
"IndexId": ...,
}
Definition
class QueryRequestRequestTypeDef(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)
UserContext: NotRequired[UserContextTypeDef], # (6)
VisitorId: NotRequired[str],
SpellCorrectionConfiguration: NotRequired[SpellCorrectionConfigurationTypeDef], # (7)
- See AttributeFilterTypeDef
- See FacetTypeDef
- See QueryResultTypeType
- See DocumentRelevanceConfigurationTypeDef
- See SortingConfigurationTypeDef
- See UserContextTypeDef
- See SpellCorrectionConfigurationTypeDef
ListExperienceEntitiesResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import ListExperienceEntitiesResponseTypeDef
def get_value() -> ListExperienceEntitiesResponseTypeDef:
return {
"SummaryItems": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListExperienceEntitiesResponseTypeDef(TypedDict):
SummaryItems: List[ExperienceEntitiesSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateExperienceRequestRequestTypeDef
def get_value() -> CreateExperienceRequestRequestTypeDef:
return {
"Name": ...,
"IndexId": ...,
}
Definition
class CreateExperienceRequestRequestTypeDef(TypedDict):
Name: str,
IndexId: str,
RoleArn: NotRequired[str],
Configuration: NotRequired[ExperienceConfigurationTypeDef], # (1)
Description: NotRequired[str],
ClientToken: NotRequired[str],
DescribeExperienceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeExperienceResponseTypeDef
def get_value() -> DescribeExperienceResponseTypeDef:
return {
"Id": ...,
"IndexId": ...,
"Name": ...,
"Endpoints": ...,
"Configuration": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"Description": ...,
"Status": ...,
"RoleArn": ...,
"ErrorMessage": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeExperienceResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Endpoints: List[ExperienceEndpointTypeDef], # (1)
Configuration: ExperienceConfigurationTypeDef, # (2)
CreatedAt: datetime,
UpdatedAt: datetime,
Description: str,
Status: ExperienceStatusType, # (3)
RoleArn: str,
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ExperienceEndpointTypeDef
- See ExperienceConfigurationTypeDef
- See ExperienceStatusType
- See ResponseMetadataTypeDef
UpdateExperienceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateExperienceRequestRequestTypeDef
def get_value() -> UpdateExperienceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class UpdateExperienceRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
RoleArn: NotRequired[str],
Configuration: NotRequired[ExperienceConfigurationTypeDef], # (1)
Description: NotRequired[str],
PutPrincipalMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import PutPrincipalMappingRequestRequestTypeDef
def get_value() -> PutPrincipalMappingRequestRequestTypeDef:
return {
"IndexId": ...,
"GroupId": ...,
"GroupMembers": ...,
}
Definition
class PutPrincipalMappingRequestRequestTypeDef(TypedDict):
IndexId: str,
GroupId: str,
GroupMembers: GroupMembersTypeDef, # (1)
DataSourceId: NotRequired[str],
OrderingId: NotRequired[int],
RoleArn: NotRequired[str],
AdditionalResultAttributeValueTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AdditionalResultAttributeValueTypeDef
def get_value() -> AdditionalResultAttributeValueTypeDef:
return {
"TextWithHighlightsValue": ...,
}
Definition
class AdditionalResultAttributeValueTypeDef(TypedDict):
TextWithHighlightsValue: NotRequired[TextWithHighlightsTypeDef], # (1)
CreateIndexRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateIndexRequestRequestTypeDef
def get_value() -> CreateIndexRequestRequestTypeDef:
return {
"Name": ...,
"RoleArn": ...,
}
Definition
class CreateIndexRequestRequestTypeDef(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 TagTypeDef
- See UserTokenConfigurationTypeDef
- See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
DescribeIndexResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeIndexResponseTypeDef
def get_value() -> DescribeIndexResponseTypeDef:
return {
"Name": ...,
"Id": ...,
"Edition": ...,
"RoleArn": ...,
"ServerSideEncryptionConfiguration": ...,
"Status": ...,
"Description": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"DocumentMetadataConfigurations": ...,
"IndexStatistics": ...,
"ErrorMessage": ...,
"CapacityUnits": ...,
"UserTokenConfigurations": ...,
"UserContextPolicy": ...,
"UserGroupResolutionConfiguration": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeIndexResponseTypeDef(TypedDict):
Name: str,
Id: str,
Edition: IndexEditionType, # (1)
RoleArn: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (2)
Status: IndexStatusType, # (3)
Description: str,
CreatedAt: datetime,
UpdatedAt: datetime,
DocumentMetadataConfigurations: List[DocumentMetadataConfigurationTypeDef], # (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 DocumentMetadataConfigurationTypeDef
- See IndexStatisticsTypeDef
- See CapacityUnitsConfigurationTypeDef
- See UserTokenConfigurationTypeDef
- See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateIndexRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateIndexRequestRequestTypeDef
def get_value() -> UpdateIndexRequestRequestTypeDef:
return {
"Id": ...,
}
Definition
class UpdateIndexRequestRequestTypeDef(TypedDict):
Id: str,
Name: NotRequired[str],
RoleArn: NotRequired[str],
Description: NotRequired[str],
DocumentMetadataConfigurationUpdates: NotRequired[Sequence[DocumentMetadataConfigurationTypeDef]], # (1)
CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef], # (2)
UserTokenConfigurations: NotRequired[Sequence[UserTokenConfigurationTypeDef]], # (3)
UserContextPolicy: NotRequired[UserContextPolicyType], # (4)
UserGroupResolutionConfiguration: NotRequired[UserGroupResolutionConfigurationTypeDef], # (5)
- See DocumentMetadataConfigurationTypeDef
- See CapacityUnitsConfigurationTypeDef
- See UserTokenConfigurationTypeDef
- See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
WebCrawlerConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import WebCrawlerConfigurationTypeDef
def get_value() -> WebCrawlerConfigurationTypeDef:
return {
"Urls": ...,
}
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
Usage Example
from types_aiobotocore_kendra.type_defs import SuggestionValueTypeDef
def get_value() -> SuggestionValueTypeDef:
return {
"Text": ...,
}
Definition
class SuggestionValueTypeDef(TypedDict):
Text: NotRequired[SuggestionTextWithHighlightsTypeDef], # (1)
SalesforceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SalesforceConfigurationTypeDef
def get_value() -> SalesforceConfigurationTypeDef:
return {
"ServerUrl": ...,
"SecretArn": ...,
}
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 SalesforceStandardObjectConfigurationTypeDef
- See SalesforceKnowledgeArticleConfigurationTypeDef
- See SalesforceChatterFeedConfigurationTypeDef
- See SalesforceStandardObjectAttachmentConfigurationTypeDef
CustomDocumentEnrichmentConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CustomDocumentEnrichmentConfigurationTypeDef
def get_value() -> CustomDocumentEnrichmentConfigurationTypeDef:
return {
"InlineConfigurations": ...,
}
Definition
class CustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
InlineConfigurations: NotRequired[Sequence[InlineCustomDocumentEnrichmentConfigurationTypeDef]], # (1)
PreExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
PostExtractionHookConfiguration: NotRequired[HookConfigurationTypeDef], # (2)
RoleArn: NotRequired[str],
- See InlineCustomDocumentEnrichmentConfigurationTypeDef
- See HookConfigurationTypeDef
- See HookConfigurationTypeDef
BatchGetDocumentStatusRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchGetDocumentStatusRequestRequestTypeDef
def get_value() -> BatchGetDocumentStatusRequestRequestTypeDef:
return {
"IndexId": ...,
"DocumentInfoList": ...,
}
Definition
class BatchGetDocumentStatusRequestRequestTypeDef(TypedDict):
IndexId: str,
DocumentInfoList: Sequence[DocumentInfoTypeDef], # (1)
AdditionalResultAttributeTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import AdditionalResultAttributeTypeDef
def get_value() -> AdditionalResultAttributeTypeDef:
return {
"Key": ...,
"ValueType": ...,
"Value": ...,
}
Definition
class AdditionalResultAttributeTypeDef(TypedDict):
Key: str,
ValueType: AdditionalResultAttributeValueTypeType, # (1)
Value: AdditionalResultAttributeValueTypeDef, # (2)
SuggestionTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import SuggestionTypeDef
def get_value() -> SuggestionTypeDef:
return {
"Id": ...,
}
Definition
class SuggestionTypeDef(TypedDict):
Id: NotRequired[str],
Value: NotRequired[SuggestionValueTypeDef], # (1)
DataSourceConfigurationTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DataSourceConfigurationTypeDef
def get_value() -> DataSourceConfigurationTypeDef:
return {
"S3Configuration": ...,
}
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
BatchPutDocumentRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import BatchPutDocumentRequestRequestTypeDef
def get_value() -> BatchPutDocumentRequestRequestTypeDef:
return {
"IndexId": ...,
"Documents": ...,
}
Definition
class BatchPutDocumentRequestRequestTypeDef(TypedDict):
IndexId: str,
Documents: Sequence[DocumentTypeDef], # (1)
RoleArn: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef], # (2)
QueryResultItemTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import QueryResultItemTypeDef
def get_value() -> QueryResultItemTypeDef:
return {
"Id": ...,
}
Definition
class QueryResultItemTypeDef(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[DocumentAttributeTypeDef]], # (5)
ScoreAttributes: NotRequired[ScoreAttributesTypeDef], # (6)
FeedbackToken: NotRequired[str],
- See QueryResultTypeType
- See AdditionalResultAttributeTypeDef
- See TextWithHighlightsTypeDef
- See TextWithHighlightsTypeDef
- See DocumentAttributeTypeDef
- See ScoreAttributesTypeDef
GetQuerySuggestionsResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import GetQuerySuggestionsResponseTypeDef
def get_value() -> GetQuerySuggestionsResponseTypeDef:
return {
"QuerySuggestionsId": ...,
"Suggestions": ...,
"ResponseMetadata": ...,
}
Definition
class GetQuerySuggestionsResponseTypeDef(TypedDict):
QuerySuggestionsId: str,
Suggestions: List[SuggestionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDataSourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import CreateDataSourceRequestRequestTypeDef
def get_value() -> CreateDataSourceRequestRequestTypeDef:
return {
"Name": ...,
"IndexId": ...,
"Type": ...,
}
Definition
class CreateDataSourceRequestRequestTypeDef(TypedDict):
Name: str,
IndexId: str,
Type: DataSourceTypeType, # (1)
Configuration: NotRequired[DataSourceConfigurationTypeDef], # (2)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (3)
Description: NotRequired[str],
Schedule: NotRequired[str],
RoleArn: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
ClientToken: NotRequired[str],
LanguageCode: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef], # (5)
- See DataSourceTypeType
- See DataSourceConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See TagTypeDef
- See CustomDocumentEnrichmentConfigurationTypeDef
DescribeDataSourceResponseTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import DescribeDataSourceResponseTypeDef
def get_value() -> DescribeDataSourceResponseTypeDef:
return {
"Id": ...,
"IndexId": ...,
"Name": ...,
"Type": ...,
"Configuration": ...,
"VpcConfiguration": ...,
"CreatedAt": ...,
"UpdatedAt": ...,
"Description": ...,
"Status": ...,
"Schedule": ...,
"RoleArn": ...,
"ErrorMessage": ...,
"LanguageCode": ...,
"CustomDocumentEnrichmentConfiguration": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDataSourceResponseTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: str,
Type: DataSourceTypeType, # (1)
Configuration: DataSourceConfigurationTypeDef, # (2)
VpcConfiguration: DataSourceVpcConfigurationTypeDef, # (3)
CreatedAt: datetime,
UpdatedAt: datetime,
Description: str,
Status: DataSourceStatusType, # (4)
Schedule: str,
RoleArn: str,
ErrorMessage: str,
LanguageCode: str,
CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See DataSourceTypeType
- See DataSourceConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See DataSourceStatusType
- See CustomDocumentEnrichmentConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateDataSourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import UpdateDataSourceRequestRequestTypeDef
def get_value() -> UpdateDataSourceRequestRequestTypeDef:
return {
"Id": ...,
"IndexId": ...,
}
Definition
class UpdateDataSourceRequestRequestTypeDef(TypedDict):
Id: str,
IndexId: str,
Name: NotRequired[str],
Configuration: NotRequired[DataSourceConfigurationTypeDef], # (1)
VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef], # (2)
Description: NotRequired[str],
Schedule: NotRequired[str],
RoleArn: NotRequired[str],
LanguageCode: NotRequired[str],
CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef], # (3)
- See DataSourceConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See CustomDocumentEnrichmentConfigurationTypeDef
QueryResultTypeDef
Usage Example
from types_aiobotocore_kendra.type_defs import QueryResultTypeDef
def get_value() -> QueryResultTypeDef:
return {
"QueryId": ...,
"ResultItems": ...,
"FacetResults": ...,
"TotalNumberOfResults": ...,
"Warnings": ...,
"SpellCorrectedQueries": ...,
"ResponseMetadata": ...,
}
Definition
class QueryResultTypeDef(TypedDict):
QueryId: str,
ResultItems: List[QueryResultItemTypeDef], # (1)
FacetResults: List[FacetResultTypeDef], # (2)
TotalNumberOfResults: int,
Warnings: List[WarningTypeDef], # (3)
SpellCorrectedQueries: List[SpellCorrectedQueryTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)