Skip to content

Typed dictionaries

Index > kendra > Typed dictionaries

Auto-generated documentation for kendra type annotations stubs module mypy-boto3-kendra.

AccessControlConfigurationSummaryTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import AccessControlConfigurationSummaryTypeDef

def get_value() -> AccessControlConfigurationSummaryTypeDef:
    return {
        "Id": ...,
    }
Definition
class AccessControlConfigurationSummaryTypeDef(TypedDict):
    Id: str,

AccessControlListConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import AccessControlListConfigurationTypeDef

def get_value() -> AccessControlListConfigurationTypeDef:
    return {
        "KeyPath": ...,
    }
Definition
class AccessControlListConfigurationTypeDef(TypedDict):
    KeyPath: NotRequired[str],

AclConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import AclConfigurationTypeDef

def get_value() -> AclConfigurationTypeDef:
    return {
        "AllowedGroupsColumnName": ...,
    }
Definition
class AclConfigurationTypeDef(TypedDict):
    AllowedGroupsColumnName: str,

DataSourceToIndexFieldMappingTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_kendra.type_defs import S3PathTypeDef

def get_value() -> S3PathTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
Definition
class S3PathTypeDef(TypedDict):
    Bucket: str,
    Key: str,

EntityConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import EntityConfigurationTypeDef

def get_value() -> EntityConfigurationTypeDef:
    return {
        "EntityId": ...,
        "EntityType": ...,
    }
Definition
class EntityConfigurationTypeDef(TypedDict):
    EntityId: str,
    EntityType: EntityTypeType,  # (1)
  1. See EntityTypeType

FailedEntityTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_kendra.type_defs import EntityPersonaConfigurationTypeDef

def get_value() -> EntityPersonaConfigurationTypeDef:
    return {
        "EntityId": ...,
        "Persona": ...,
    }
Definition
class EntityPersonaConfigurationTypeDef(TypedDict):
    EntityId: str,
    Persona: PersonaType,  # (1)
  1. See PersonaType

BasicAuthenticationConfigurationTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_kendra.type_defs import DataSourceSyncJobMetricTargetTypeDef

def get_value() -> DataSourceSyncJobMetricTargetTypeDef:
    return {
        "DataSourceId": ...,
    }
Definition
class DataSourceSyncJobMetricTargetTypeDef(TypedDict):
    DataSourceId: str,
    DataSourceSyncJobId: NotRequired[str],

BatchDeleteDocumentResponseFailedDocumentTypeDef

Usage Example
from mypy_boto3_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],
  1. See ErrorCodeType

BatchGetDocumentStatusResponseErrorTypeDef

Usage Example
from mypy_boto3_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],
  1. See ErrorCodeType

StatusTypeDef

Usage Example
from mypy_boto3_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],
  1. See DocumentStatusType

BatchPutDocumentResponseFailedDocumentTypeDef

Usage Example
from mypy_boto3_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],
  1. See ErrorCodeType

CapacityUnitsConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import CapacityUnitsConfigurationTypeDef

def get_value() -> CapacityUnitsConfigurationTypeDef:
    return {
        "StorageCapacityUnits": ...,
        "QueryCapacityUnits": ...,
    }
Definition
class CapacityUnitsConfigurationTypeDef(TypedDict):
    StorageCapacityUnits: int,
    QueryCapacityUnits: int,

ClearQuerySuggestionsRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ClearQuerySuggestionsRequestRequestTypeDef

def get_value() -> ClearQuerySuggestionsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
Definition
class ClearQuerySuggestionsRequestRequestTypeDef(TypedDict):
    IndexId: str,

ClickFeedbackTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ClickFeedbackTypeDef

def get_value() -> ClickFeedbackTypeDef:
    return {
        "ResultId": ...,
        "ClickTime": ...,
    }
Definition
class ClickFeedbackTypeDef(TypedDict):
    ResultId: str,
    ClickTime: Union[datetime, str],

ConfluenceAttachmentToIndexFieldMappingTypeDef

Usage Example
from mypy_boto3_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],
  1. See ConfluenceAttachmentFieldNameType

ConfluenceBlogToIndexFieldMappingTypeDef

Usage Example
from mypy_boto3_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],
  1. See ConfluenceBlogFieldNameType

ProxyConfigurationTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See ConfluencePageFieldNameType

ConfluenceSpaceToIndexFieldMappingTypeDef

Usage Example
from mypy_boto3_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],
  1. See ConfluenceSpaceFieldNameType

ConnectionConfigurationTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See PrincipalTypeType
  2. See ReadAccessTypeType

TagTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ServerSideEncryptionConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ServerSideEncryptionConfigurationTypeDef

def get_value() -> ServerSideEncryptionConfigurationTypeDef:
    return {
        "KmsKeyId": ...,
    }
Definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
    KmsKeyId: NotRequired[str],

UserGroupResolutionConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import UserGroupResolutionConfigurationTypeDef

def get_value() -> UserGroupResolutionConfigurationTypeDef:
    return {
        "UserGroupResolutionMode": ...,
    }
Definition
class UserGroupResolutionConfigurationTypeDef(TypedDict):
    UserGroupResolutionMode: UserGroupResolutionModeType,  # (1)
  1. See UserGroupResolutionModeType

TemplateConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import TemplateConfigurationTypeDef

def get_value() -> TemplateConfigurationTypeDef:
    return {
        "Template": ...,
    }
Definition
class TemplateConfigurationTypeDef(TypedDict):
    Template: NotRequired[Mapping[str, Any]],

DataSourceGroupTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DataSourceGroupTypeDef

def get_value() -> DataSourceGroupTypeDef:
    return {
        "GroupId": ...,
        "DataSourceId": ...,
    }
Definition
class DataSourceGroupTypeDef(TypedDict):
    GroupId: str,
    DataSourceId: str,

DataSourceSummaryTypeDef

Usage Example
from mypy_boto3_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],
  1. See DataSourceTypeType
  2. See DataSourceStatusType

DataSourceSyncJobMetricsTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_kendra.type_defs import SqlConfigurationTypeDef

def get_value() -> SqlConfigurationTypeDef:
    return {
        "QueryIdentifiersEnclosingOption": ...,
    }
Definition
class SqlConfigurationTypeDef(TypedDict):
    QueryIdentifiersEnclosingOption: NotRequired[QueryIdentifiersEnclosingOptionType],  # (1)
  1. See QueryIdentifiersEnclosingOptionType

DeleteAccessControlConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteAccessControlConfigurationRequestRequestTypeDef

def get_value() -> DeleteAccessControlConfigurationRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
Definition
class DeleteAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DeleteDataSourceRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteDataSourceRequestRequestTypeDef

def get_value() -> DeleteDataSourceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteExperienceRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteExperienceRequestRequestTypeDef

def get_value() -> DeleteExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DeleteExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteFaqRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteFaqRequestRequestTypeDef

def get_value() -> DeleteFaqRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DeleteFaqRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteIndexRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteIndexRequestRequestTypeDef

def get_value() -> DeleteIndexRequestRequestTypeDef:
    return {
        "Id": ...,
    }
Definition
class DeleteIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DeletePrincipalMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_kendra.type_defs import DeleteQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> DeleteQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
Definition
class DeleteQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DeleteThesaurusRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DeleteThesaurusRequestRequestTypeDef

def get_value() -> DeleteThesaurusRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DeleteThesaurusRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeAccessControlConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeAccessControlConfigurationRequestRequestTypeDef

def get_value() -> DescribeAccessControlConfigurationRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
Definition
class DescribeAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DescribeDataSourceRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeDataSourceRequestRequestTypeDef

def get_value() -> DescribeDataSourceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DescribeDataSourceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeExperienceRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeExperienceRequestRequestTypeDef

def get_value() -> DescribeExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DescribeExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

ExperienceEndpointTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ExperienceEndpointTypeDef

def get_value() -> ExperienceEndpointTypeDef:
    return {
        "EndpointType": ...,
    }
Definition
class ExperienceEndpointTypeDef(TypedDict):
    EndpointType: NotRequired[EndpointTypeType],  # (1)
    Endpoint: NotRequired[str],
  1. See EndpointTypeType

DescribeFaqRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeFaqRequestRequestTypeDef

def get_value() -> DescribeFaqRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DescribeFaqRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeIndexRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeIndexRequestRequestTypeDef

def get_value() -> DescribeIndexRequestRequestTypeDef:
    return {
        "Id": ...,
    }
Definition
class DescribeIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DescribePrincipalMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See PrincipalMappingStatusType

DescribeQuerySuggestionsBlockListRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> DescribeQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
Definition
class DescribeQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DescribeQuerySuggestionsConfigRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeQuerySuggestionsConfigRequestRequestTypeDef

def get_value() -> DescribeQuerySuggestionsConfigRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
Definition
class DescribeQuerySuggestionsConfigRequestRequestTypeDef(TypedDict):
    IndexId: str,

DescribeThesaurusRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import DescribeThesaurusRequestRequestTypeDef

def get_value() -> DescribeThesaurusRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class DescribeThesaurusRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DisassociatePersonasFromEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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]],
  1. See OrderType

SearchTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_kendra.type_defs import DocumentsMetadataConfigurationTypeDef

def get_value() -> DocumentsMetadataConfigurationTypeDef:
    return {
        "S3Prefix": ...,
    }
Definition
class DocumentsMetadataConfigurationTypeDef(TypedDict):
    S3Prefix: NotRequired[str],

EntityDisplayDataTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_kendra.type_defs import UserIdentityConfigurationTypeDef

def get_value() -> UserIdentityConfigurationTypeDef:
    return {
        "IdentityAttributeName": ...,
    }
Definition
class UserIdentityConfigurationTypeDef(TypedDict):
    IdentityAttributeName: NotRequired[str],

FacetResultTypeDef

Usage Example
from mypy_boto3_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)
  1. See DocumentAttributeValueTypeType
  2. See DocumentAttributeValueCountPairTypeDef

FacetTypeDef

Usage Example
from mypy_boto3_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],
  1. See FacetTypeDef

FaqStatisticsTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import FaqStatisticsTypeDef

def get_value() -> FaqStatisticsTypeDef:
    return {
        "IndexedQuestionAnswersCount": ...,
    }
Definition
class FaqStatisticsTypeDef(TypedDict):
    IndexedQuestionAnswersCount: int,

FaqSummaryTypeDef

Usage Example
from mypy_boto3_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],
  1. See FaqStatusType
  2. See FaqFileFormatType

GetQuerySuggestionsRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See IntervalType
  2. See MetricTypeType

TimeRangeTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_kendra.type_defs import SaaSConfigurationTypeDef

def get_value() -> SaaSConfigurationTypeDef:
    return {
        "OrganizationName": ...,
        "HostUrl": ...,
    }
Definition
class SaaSConfigurationTypeDef(TypedDict):
    OrganizationName: str,
    HostUrl: str,

MemberGroupTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import MemberGroupTypeDef

def get_value() -> MemberGroupTypeDef:
    return {
        "GroupId": ...,
    }
Definition
class MemberGroupTypeDef(TypedDict):
    GroupId: str,
    DataSourceId: NotRequired[str],

MemberUserTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import MemberUserTypeDef

def get_value() -> MemberUserTypeDef:
    return {
        "UserId": ...,
    }
Definition
class MemberUserTypeDef(TypedDict):
    UserId: str,

GroupSummaryTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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)
  1. See HighlightTypeType

IndexConfigurationSummaryTypeDef

Usage Example
from mypy_boto3_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)
  1. See IndexEditionType
  2. See IndexStatusType

TextDocumentStatisticsTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import TextDocumentStatisticsTypeDef

def get_value() -> TextDocumentStatisticsTypeDef:
    return {
        "IndexedTextDocumentsCount": ...,
        "IndexedTextBytes": ...,
    }
Definition
class TextDocumentStatisticsTypeDef(TypedDict):
    IndexedTextDocumentsCount: int,
    IndexedTextBytes: int,

JsonTokenTypeConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import JsonTokenTypeConfigurationTypeDef

def get_value() -> JsonTokenTypeConfigurationTypeDef:
    return {
        "UserNameAttributeField": ...,
        "GroupAttributeField": ...,
    }
Definition
class JsonTokenTypeConfigurationTypeDef(TypedDict):
    UserNameAttributeField: str,
    GroupAttributeField: str,

JwtTokenTypeConfigurationTypeDef

Usage Example
from mypy_boto3_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],
  1. See KeyLocationType

ListAccessControlConfigurationsRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See PersonaType

ListExperienceEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See QuerySuggestionsBlockListStatusType

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

ListThesauriRequestRequestTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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],
  1. See ThesaurusStatusType

SortingConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import SortingConfigurationTypeDef

def get_value() -> SortingConfigurationTypeDef:
    return {
        "DocumentAttributeKey": ...,
        "SortOrder": ...,
    }
Definition
class SortingConfigurationTypeDef(TypedDict):
    DocumentAttributeKey: str,
    SortOrder: SortOrderType,  # (1)
  1. See SortOrderType

SpellCorrectionConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import SpellCorrectionConfigurationTypeDef

def get_value() -> SpellCorrectionConfigurationTypeDef:
    return {
        "IncludeQuerySpellCheckSuggestions": ...,
    }
Definition
class SpellCorrectionConfigurationTypeDef(TypedDict):
    IncludeQuerySpellCheckSuggestions: bool,

ScoreAttributesTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import ScoreAttributesTypeDef

def get_value() -> ScoreAttributesTypeDef:
    return {
        "ScoreConfidence": ...,
    }
Definition
class ScoreAttributesTypeDef(TypedDict):
    ScoreConfidence: NotRequired[ScoreConfidenceType],  # (1)
  1. See ScoreConfidenceType

WarningTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import WarningTypeDef

def get_value() -> WarningTypeDef:
    return {
        "Message": ...,
    }
Definition
class WarningTypeDef(TypedDict):
    Message: NotRequired[str],
    Code: NotRequired[WarningCodeType],  # (1)
  1. See WarningCodeType

RelevanceFeedbackTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import RelevanceFeedbackTypeDef

def get_value() -> RelevanceFeedbackTypeDef:
    return {
        "ResultId": ...,
        "RelevanceValue": ...,
    }
Definition
class RelevanceFeedbackTypeDef(TypedDict):
    ResultId: str,
    RelevanceValue: RelevanceTypeType,  # (1)
  1. See RelevanceTypeType

SeedUrlConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import SeedUrlConfigurationTypeDef

def get_value() -> SeedUrlConfigurationTypeDef:
    return {
        "SeedUrls": ...,
    }
Definition
class SeedUrlConfigurationTypeDef(TypedDict):
    SeedUrls: Sequence[str],
    WebCrawlerMode: NotRequired[WebCrawlerModeType],  # (1)
  1. See WebCrawlerModeType

SiteMapsConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import SiteMapsConfigurationTypeDef

def get_value() -> SiteMapsConfigurationTypeDef:
    return {
        "SiteMaps": ...,
    }
Definition
class SiteMapsConfigurationTypeDef(TypedDict):
    SiteMaps: Sequence[str],

StartDataSourceSyncJobRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import StartDataSourceSyncJobRequestRequestTypeDef

def get_value() -> StartDataSourceSyncJobRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class StartDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

StopDataSourceSyncJobRequestRequestTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import StopDataSourceSyncJobRequestRequestTypeDef

def get_value() -> StopDataSourceSyncJobRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
Definition
class StopDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

SuggestionHighlightTypeDef

Usage Example
from mypy_boto3_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 mypy_boto3_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 mypy_boto3_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],
  1. See ModeType

ColumnConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef

GoogleDriveConfigurationTypeDef

Usage Example
from mypy_boto3_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]],
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceChatterFeedConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See SalesforceChatterFeedIncludeFilterTypeType

SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardObjectAttachmentConfigurationTypeDef

Usage Example
from mypy_boto3_kendra.type_defs import SalesforceStandardObjectAttachmentConfigurationTypeDef

def get_value() -> SalesforceStandardObjectAttachmentConfigurationTypeDef:
    return {
        "DocumentTitleFieldName": ...,
    }
Definition
class SalesforceStandardObjectAttachmentConfigurationTypeDef(TypedDict):
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardObjectConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See SalesforceStandardObjectNameType
  2. See DataSourceToIndexFieldMappingTypeDef

ServiceNowKnowledgeArticleConfigurationTypeDef

Usage Example
from mypy_boto3_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],
  1. See DataSourceToIndexFieldMappingTypeDef

ServiceNowServiceCatalogConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef

WorkDocsConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef

BoxConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceVpcConfigurationTypeDef

FsxConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See FsxFileSystemTypeType
  2. See DataSourceVpcConfigurationTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef

JiraConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See IssueSubEntityType
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceToIndexFieldMappingTypeDef
  6. See DataSourceToIndexFieldMappingTypeDef
  7. See DataSourceVpcConfigurationTypeDef

QuipConfigurationTypeDef

Usage Example
from mypy_boto3_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)
  1. See