Skip to content

Typed dictionaries#

Index > kendra > Typed dictionaries

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

AccessControlConfigurationSummaryTypeDef#

# AccessControlConfigurationSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import AccessControlConfigurationSummaryTypeDef

def get_value() -> AccessControlConfigurationSummaryTypeDef:
    return {
        "Id": ...,
    }
# AccessControlConfigurationSummaryTypeDef definition

class AccessControlConfigurationSummaryTypeDef(TypedDict):
    Id: str,

AccessControlListConfigurationTypeDef#

# AccessControlListConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import AccessControlListConfigurationTypeDef

def get_value() -> AccessControlListConfigurationTypeDef:
    return {
        "KeyPath": ...,
    }
# AccessControlListConfigurationTypeDef definition

class AccessControlListConfigurationTypeDef(TypedDict):
    KeyPath: NotRequired[str],

AclConfigurationTypeDef#

# AclConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import AclConfigurationTypeDef

def get_value() -> AclConfigurationTypeDef:
    return {
        "AllowedGroupsColumnName": ...,
    }
# AclConfigurationTypeDef definition

class AclConfigurationTypeDef(TypedDict):
    AllowedGroupsColumnName: str,

DataSourceToIndexFieldMappingTypeDef#

# DataSourceToIndexFieldMappingTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceToIndexFieldMappingTypeDef

def get_value() -> DataSourceToIndexFieldMappingTypeDef:
    return {
        "DataSourceFieldName": ...,
        "IndexFieldName": ...,
    }
# DataSourceToIndexFieldMappingTypeDef definition

class DataSourceToIndexFieldMappingTypeDef(TypedDict):
    DataSourceFieldName: str,
    IndexFieldName: str,
    DateFieldFormat: NotRequired[str],

DataSourceVpcConfigurationTypeDef#

# DataSourceVpcConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceVpcConfigurationTypeDef

def get_value() -> DataSourceVpcConfigurationTypeDef:
    return {
        "SubnetIds": ...,
        "SecurityGroupIds": ...,
    }
# DataSourceVpcConfigurationTypeDef definition

class DataSourceVpcConfigurationTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    SecurityGroupIds: Sequence[str],

S3PathTypeDef#

# S3PathTypeDef usage example

from mypy_boto3_kendra.type_defs import S3PathTypeDef

def get_value() -> S3PathTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# S3PathTypeDef definition

class S3PathTypeDef(TypedDict):
    Bucket: str,
    Key: str,

EntityConfigurationTypeDef#

# EntityConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import EntityConfigurationTypeDef

def get_value() -> EntityConfigurationTypeDef:
    return {
        "EntityId": ...,
        "EntityType": ...,
    }
# EntityConfigurationTypeDef definition

class EntityConfigurationTypeDef(TypedDict):
    EntityId: str,
    EntityType: EntityTypeType,  # (1)
  1. See EntityTypeType

FailedEntityTypeDef#

# FailedEntityTypeDef usage example

from mypy_boto3_kendra.type_defs import FailedEntityTypeDef

def get_value() -> FailedEntityTypeDef:
    return {
        "EntityId": ...,
    }
# FailedEntityTypeDef definition

class FailedEntityTypeDef(TypedDict):
    EntityId: NotRequired[str],
    ErrorMessage: NotRequired[str],

EntityPersonaConfigurationTypeDef#

# EntityPersonaConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import EntityPersonaConfigurationTypeDef

def get_value() -> EntityPersonaConfigurationTypeDef:
    return {
        "EntityId": ...,
        "Persona": ...,
    }
# EntityPersonaConfigurationTypeDef definition

class EntityPersonaConfigurationTypeDef(TypedDict):
    EntityId: str,
    Persona: PersonaType,  # (1)
  1. See PersonaType

SuggestableConfigTypeDef#

# SuggestableConfigTypeDef usage example

from mypy_boto3_kendra.type_defs import SuggestableConfigTypeDef

def get_value() -> SuggestableConfigTypeDef:
    return {
        "AttributeName": ...,
    }
# SuggestableConfigTypeDef definition

class SuggestableConfigTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    Suggestable: NotRequired[bool],

BasicAuthenticationConfigurationTypeDef#

# BasicAuthenticationConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import BasicAuthenticationConfigurationTypeDef

def get_value() -> BasicAuthenticationConfigurationTypeDef:
    return {
        "Host": ...,
        "Port": ...,
        "Credentials": ...,
    }
# BasicAuthenticationConfigurationTypeDef definition

class BasicAuthenticationConfigurationTypeDef(TypedDict):
    Host: str,
    Port: int,
    Credentials: str,

DataSourceSyncJobMetricTargetTypeDef#

# DataSourceSyncJobMetricTargetTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceSyncJobMetricTargetTypeDef

def get_value() -> DataSourceSyncJobMetricTargetTypeDef:
    return {
        "DataSourceId": ...,
    }
# DataSourceSyncJobMetricTargetTypeDef definition

class DataSourceSyncJobMetricTargetTypeDef(TypedDict):
    DataSourceId: str,
    DataSourceSyncJobId: NotRequired[str],

BatchDeleteDocumentResponseFailedDocumentTypeDef#

# BatchDeleteDocumentResponseFailedDocumentTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteDocumentResponseFailedDocumentTypeDef

def get_value() -> BatchDeleteDocumentResponseFailedDocumentTypeDef:
    return {
        "Id": ...,
    }
# BatchDeleteDocumentResponseFailedDocumentTypeDef definition

class BatchDeleteDocumentResponseFailedDocumentTypeDef(TypedDict):
    Id: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See ErrorCodeType

BatchDeleteFeaturedResultsSetErrorTypeDef#

# BatchDeleteFeaturedResultsSetErrorTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetErrorTypeDef

def get_value() -> BatchDeleteFeaturedResultsSetErrorTypeDef:
    return {
        "Id": ...,
        "ErrorCode": ...,
        "ErrorMessage": ...,
    }
# BatchDeleteFeaturedResultsSetErrorTypeDef definition

class BatchDeleteFeaturedResultsSetErrorTypeDef(TypedDict):
    Id: str,
    ErrorCode: ErrorCodeType,  # (1)
    ErrorMessage: str,
  1. See ErrorCodeType

BatchDeleteFeaturedResultsSetRequestRequestTypeDef#

# BatchDeleteFeaturedResultsSetRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetRequestRequestTypeDef

def get_value() -> BatchDeleteFeaturedResultsSetRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "FeaturedResultsSetIds": ...,
    }
# BatchDeleteFeaturedResultsSetRequestRequestTypeDef definition

class BatchDeleteFeaturedResultsSetRequestRequestTypeDef(TypedDict):
    IndexId: str,
    FeaturedResultsSetIds: Sequence[str],

BatchGetDocumentStatusResponseErrorTypeDef#

# BatchGetDocumentStatusResponseErrorTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchGetDocumentStatusResponseErrorTypeDef

def get_value() -> BatchGetDocumentStatusResponseErrorTypeDef:
    return {
        "DocumentId": ...,
    }
# BatchGetDocumentStatusResponseErrorTypeDef definition

class BatchGetDocumentStatusResponseErrorTypeDef(TypedDict):
    DocumentId: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See ErrorCodeType

StatusTypeDef#

# StatusTypeDef usage example

from mypy_boto3_kendra.type_defs import StatusTypeDef

def get_value() -> StatusTypeDef:
    return {
        "DocumentId": ...,
    }
# StatusTypeDef definition

class StatusTypeDef(TypedDict):
    DocumentId: NotRequired[str],
    DocumentStatus: NotRequired[DocumentStatusType],  # (1)
    FailureCode: NotRequired[str],
    FailureReason: NotRequired[str],
  1. See DocumentStatusType

BatchPutDocumentResponseFailedDocumentTypeDef#

# BatchPutDocumentResponseFailedDocumentTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchPutDocumentResponseFailedDocumentTypeDef

def get_value() -> BatchPutDocumentResponseFailedDocumentTypeDef:
    return {
        "Id": ...,
    }
# BatchPutDocumentResponseFailedDocumentTypeDef definition

class BatchPutDocumentResponseFailedDocumentTypeDef(TypedDict):
    Id: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See ErrorCodeType

CapacityUnitsConfigurationTypeDef#

# CapacityUnitsConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import CapacityUnitsConfigurationTypeDef

def get_value() -> CapacityUnitsConfigurationTypeDef:
    return {
        "StorageCapacityUnits": ...,
        "QueryCapacityUnits": ...,
    }
# CapacityUnitsConfigurationTypeDef definition

class CapacityUnitsConfigurationTypeDef(TypedDict):
    StorageCapacityUnits: int,
    QueryCapacityUnits: int,

ClearQuerySuggestionsRequestRequestTypeDef#

# ClearQuerySuggestionsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ClearQuerySuggestionsRequestRequestTypeDef

def get_value() -> ClearQuerySuggestionsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ClearQuerySuggestionsRequestRequestTypeDef definition

class ClearQuerySuggestionsRequestRequestTypeDef(TypedDict):
    IndexId: str,

ClickFeedbackTypeDef#

# ClickFeedbackTypeDef usage example

from mypy_boto3_kendra.type_defs import ClickFeedbackTypeDef

def get_value() -> ClickFeedbackTypeDef:
    return {
        "ResultId": ...,
        "ClickTime": ...,
    }
# ClickFeedbackTypeDef definition

class ClickFeedbackTypeDef(TypedDict):
    ResultId: str,
    ClickTime: Union[datetime, str],

ConfluenceAttachmentToIndexFieldMappingTypeDef#

# ConfluenceAttachmentToIndexFieldMappingTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceAttachmentToIndexFieldMappingTypeDef

def get_value() -> ConfluenceAttachmentToIndexFieldMappingTypeDef:
    return {
        "DataSourceFieldName": ...,
    }
# ConfluenceAttachmentToIndexFieldMappingTypeDef definition

class ConfluenceAttachmentToIndexFieldMappingTypeDef(TypedDict):
    DataSourceFieldName: NotRequired[ConfluenceAttachmentFieldNameType],  # (1)
    DateFieldFormat: NotRequired[str],
    IndexFieldName: NotRequired[str],
  1. See ConfluenceAttachmentFieldNameType

ConfluenceBlogToIndexFieldMappingTypeDef#

# ConfluenceBlogToIndexFieldMappingTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceBlogToIndexFieldMappingTypeDef

def get_value() -> ConfluenceBlogToIndexFieldMappingTypeDef:
    return {
        "DataSourceFieldName": ...,
    }
# ConfluenceBlogToIndexFieldMappingTypeDef definition

class ConfluenceBlogToIndexFieldMappingTypeDef(TypedDict):
    DataSourceFieldName: NotRequired[ConfluenceBlogFieldNameType],  # (1)
    DateFieldFormat: NotRequired[str],
    IndexFieldName: NotRequired[str],
  1. See ConfluenceBlogFieldNameType

ProxyConfigurationTypeDef#

# ProxyConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ProxyConfigurationTypeDef

def get_value() -> ProxyConfigurationTypeDef:
    return {
        "Host": ...,
        "Port": ...,
    }
# ProxyConfigurationTypeDef definition

class ProxyConfigurationTypeDef(TypedDict):
    Host: str,
    Port: int,
    Credentials: NotRequired[str],

ConfluencePageToIndexFieldMappingTypeDef#

# ConfluencePageToIndexFieldMappingTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluencePageToIndexFieldMappingTypeDef

def get_value() -> ConfluencePageToIndexFieldMappingTypeDef:
    return {
        "DataSourceFieldName": ...,
    }
# ConfluencePageToIndexFieldMappingTypeDef definition

class ConfluencePageToIndexFieldMappingTypeDef(TypedDict):
    DataSourceFieldName: NotRequired[ConfluencePageFieldNameType],  # (1)
    DateFieldFormat: NotRequired[str],
    IndexFieldName: NotRequired[str],
  1. See ConfluencePageFieldNameType

ConfluenceSpaceToIndexFieldMappingTypeDef#

# ConfluenceSpaceToIndexFieldMappingTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceSpaceToIndexFieldMappingTypeDef

def get_value() -> ConfluenceSpaceToIndexFieldMappingTypeDef:
    return {
        "DataSourceFieldName": ...,
    }
# ConfluenceSpaceToIndexFieldMappingTypeDef definition

class ConfluenceSpaceToIndexFieldMappingTypeDef(TypedDict):
    DataSourceFieldName: NotRequired[ConfluenceSpaceFieldNameType],  # (1)
    DateFieldFormat: NotRequired[str],
    IndexFieldName: NotRequired[str],
  1. See ConfluenceSpaceFieldNameType

ConnectionConfigurationTypeDef#

# ConnectionConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ConnectionConfigurationTypeDef

def get_value() -> ConnectionConfigurationTypeDef:
    return {
        "DatabaseHost": ...,
        "DatabasePort": ...,
        "DatabaseName": ...,
        "TableName": ...,
        "SecretArn": ...,
    }
# ConnectionConfigurationTypeDef definition

class ConnectionConfigurationTypeDef(TypedDict):
    DatabaseHost: str,
    DatabasePort: int,
    DatabaseName: str,
    TableName: str,
    SecretArn: str,

ContentSourceConfigurationTypeDef#

# ContentSourceConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ContentSourceConfigurationTypeDef

def get_value() -> ContentSourceConfigurationTypeDef:
    return {
        "DataSourceIds": ...,
    }
# ContentSourceConfigurationTypeDef definition

class ContentSourceConfigurationTypeDef(TypedDict):
    DataSourceIds: NotRequired[Sequence[str]],
    FaqIds: NotRequired[Sequence[str]],
    DirectPutContent: NotRequired[bool],

CorrectionTypeDef#

# CorrectionTypeDef usage example

from mypy_boto3_kendra.type_defs import CorrectionTypeDef

def get_value() -> CorrectionTypeDef:
    return {
        "BeginOffset": ...,
    }
# CorrectionTypeDef definition

class CorrectionTypeDef(TypedDict):
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],
    Term: NotRequired[str],
    CorrectedTerm: NotRequired[str],

PrincipalTypeDef#

# PrincipalTypeDef usage example

from mypy_boto3_kendra.type_defs import PrincipalTypeDef

def get_value() -> PrincipalTypeDef:
    return {
        "Name": ...,
        "Type": ...,
        "Access": ...,
    }
# PrincipalTypeDef definition

class PrincipalTypeDef(TypedDict):
    Name: str,
    Type: PrincipalTypeType,  # (1)
    Access: ReadAccessTypeType,  # (2)
    DataSourceId: NotRequired[str],
  1. See PrincipalTypeType
  2. See ReadAccessTypeType

CreateAccessControlConfigurationResponseTypeDef#

# CreateAccessControlConfigurationResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateAccessControlConfigurationResponseTypeDef

def get_value() -> CreateAccessControlConfigurationResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateAccessControlConfigurationResponseTypeDef definition

class CreateAccessControlConfigurationResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_kendra.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateDataSourceResponseTypeDef

def get_value() -> CreateDataSourceResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateDataSourceResponseTypeDef definition

class CreateDataSourceResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateExperienceResponseTypeDef#

# CreateExperienceResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateExperienceResponseTypeDef

def get_value() -> CreateExperienceResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateExperienceResponseTypeDef definition

class CreateExperienceResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFaqResponseTypeDef#

# CreateFaqResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateFaqResponseTypeDef

def get_value() -> CreateFaqResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateFaqResponseTypeDef definition

class CreateFaqResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FeaturedDocumentTypeDef#

# FeaturedDocumentTypeDef usage example

from mypy_boto3_kendra.type_defs import FeaturedDocumentTypeDef

def get_value() -> FeaturedDocumentTypeDef:
    return {
        "Id": ...,
    }
# FeaturedDocumentTypeDef definition

class FeaturedDocumentTypeDef(TypedDict):
    Id: NotRequired[str],

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ServerSideEncryptionConfigurationTypeDef

def get_value() -> ServerSideEncryptionConfigurationTypeDef:
    return {
        "KmsKeyId": ...,
    }
# ServerSideEncryptionConfigurationTypeDef definition

class ServerSideEncryptionConfigurationTypeDef(TypedDict):
    KmsKeyId: NotRequired[str],

UserGroupResolutionConfigurationTypeDef#

# UserGroupResolutionConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import UserGroupResolutionConfigurationTypeDef

def get_value() -> UserGroupResolutionConfigurationTypeDef:
    return {
        "UserGroupResolutionMode": ...,
    }
# UserGroupResolutionConfigurationTypeDef definition

class UserGroupResolutionConfigurationTypeDef(TypedDict):
    UserGroupResolutionMode: UserGroupResolutionModeType,  # (1)
  1. See UserGroupResolutionModeType

CreateIndexResponseTypeDef#

# CreateIndexResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateIndexResponseTypeDef

def get_value() -> CreateIndexResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateIndexResponseTypeDef definition

class CreateIndexResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateQuerySuggestionsBlockListResponseTypeDef#

# CreateQuerySuggestionsBlockListResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateQuerySuggestionsBlockListResponseTypeDef

def get_value() -> CreateQuerySuggestionsBlockListResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateQuerySuggestionsBlockListResponseTypeDef definition

class CreateQuerySuggestionsBlockListResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateThesaurusResponseTypeDef#

# CreateThesaurusResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateThesaurusResponseTypeDef

def get_value() -> CreateThesaurusResponseTypeDef:
    return {
        "Id": ...,
        "ResponseMetadata": ...,
    }
# CreateThesaurusResponseTypeDef definition

class CreateThesaurusResponseTypeDef(TypedDict):
    Id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TemplateConfigurationTypeDef#

# TemplateConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import TemplateConfigurationTypeDef

def get_value() -> TemplateConfigurationTypeDef:
    return {
        "Template": ...,
    }
# TemplateConfigurationTypeDef definition

class TemplateConfigurationTypeDef(TypedDict):
    Template: NotRequired[Mapping[str, Any]],

DataSourceGroupTypeDef#

# DataSourceGroupTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceGroupTypeDef

def get_value() -> DataSourceGroupTypeDef:
    return {
        "GroupId": ...,
        "DataSourceId": ...,
    }
# DataSourceGroupTypeDef definition

class DataSourceGroupTypeDef(TypedDict):
    GroupId: str,
    DataSourceId: str,

DataSourceSummaryTypeDef#

# DataSourceSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceSummaryTypeDef

def get_value() -> DataSourceSummaryTypeDef:
    return {
        "Name": ...,
    }
# DataSourceSummaryTypeDef definition

class DataSourceSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Type: NotRequired[DataSourceTypeType],  # (1)
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
    Status: NotRequired[DataSourceStatusType],  # (2)
    LanguageCode: NotRequired[str],
  1. See DataSourceTypeType
  2. See DataSourceStatusType

DataSourceSyncJobMetricsTypeDef#

# DataSourceSyncJobMetricsTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceSyncJobMetricsTypeDef

def get_value() -> DataSourceSyncJobMetricsTypeDef:
    return {
        "DocumentsAdded": ...,
    }
# DataSourceSyncJobMetricsTypeDef definition

class DataSourceSyncJobMetricsTypeDef(TypedDict):
    DocumentsAdded: NotRequired[str],
    DocumentsModified: NotRequired[str],
    DocumentsDeleted: NotRequired[str],
    DocumentsFailed: NotRequired[str],
    DocumentsScanned: NotRequired[str],

SqlConfigurationTypeDef#

# SqlConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SqlConfigurationTypeDef

def get_value() -> SqlConfigurationTypeDef:
    return {
        "QueryIdentifiersEnclosingOption": ...,
    }
# SqlConfigurationTypeDef definition

class SqlConfigurationTypeDef(TypedDict):
    QueryIdentifiersEnclosingOption: NotRequired[QueryIdentifiersEnclosingOptionType],  # (1)
  1. See QueryIdentifiersEnclosingOptionType

DeleteAccessControlConfigurationRequestRequestTypeDef#

# DeleteAccessControlConfigurationRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteAccessControlConfigurationRequestRequestTypeDef

def get_value() -> DeleteAccessControlConfigurationRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
# DeleteAccessControlConfigurationRequestRequestTypeDef definition

class DeleteAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteDataSourceRequestRequestTypeDef

def get_value() -> DeleteDataSourceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DeleteDataSourceRequestRequestTypeDef definition

class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteExperienceRequestRequestTypeDef#

# DeleteExperienceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteExperienceRequestRequestTypeDef

def get_value() -> DeleteExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DeleteExperienceRequestRequestTypeDef definition

class DeleteExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteFaqRequestRequestTypeDef#

# DeleteFaqRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteFaqRequestRequestTypeDef

def get_value() -> DeleteFaqRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DeleteFaqRequestRequestTypeDef definition

class DeleteFaqRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DeleteIndexRequestRequestTypeDef#

# DeleteIndexRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteIndexRequestRequestTypeDef

def get_value() -> DeleteIndexRequestRequestTypeDef:
    return {
        "Id": ...,
    }
# DeleteIndexRequestRequestTypeDef definition

class DeleteIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DeletePrincipalMappingRequestRequestTypeDef#

# DeletePrincipalMappingRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeletePrincipalMappingRequestRequestTypeDef

def get_value() -> DeletePrincipalMappingRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "GroupId": ...,
    }
# DeletePrincipalMappingRequestRequestTypeDef definition

class DeletePrincipalMappingRequestRequestTypeDef(TypedDict):
    IndexId: str,
    GroupId: str,
    DataSourceId: NotRequired[str],
    OrderingId: NotRequired[int],

DeleteQuerySuggestionsBlockListRequestRequestTypeDef#

# DeleteQuerySuggestionsBlockListRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> DeleteQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
# DeleteQuerySuggestionsBlockListRequestRequestTypeDef definition

class DeleteQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DeleteThesaurusRequestRequestTypeDef#

# DeleteThesaurusRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DeleteThesaurusRequestRequestTypeDef

def get_value() -> DeleteThesaurusRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DeleteThesaurusRequestRequestTypeDef definition

class DeleteThesaurusRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeAccessControlConfigurationRequestRequestTypeDef#

# DescribeAccessControlConfigurationRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeAccessControlConfigurationRequestRequestTypeDef

def get_value() -> DescribeAccessControlConfigurationRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
# DescribeAccessControlConfigurationRequestRequestTypeDef definition

class DescribeAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DescribeDataSourceRequestRequestTypeDef#

# DescribeDataSourceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeDataSourceRequestRequestTypeDef

def get_value() -> DescribeDataSourceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DescribeDataSourceRequestRequestTypeDef definition

class DescribeDataSourceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeExperienceRequestRequestTypeDef#

# DescribeExperienceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeExperienceRequestRequestTypeDef

def get_value() -> DescribeExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DescribeExperienceRequestRequestTypeDef definition

class DescribeExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

ExperienceEndpointTypeDef#

# ExperienceEndpointTypeDef usage example

from mypy_boto3_kendra.type_defs import ExperienceEndpointTypeDef

def get_value() -> ExperienceEndpointTypeDef:
    return {
        "EndpointType": ...,
    }
# ExperienceEndpointTypeDef definition

class ExperienceEndpointTypeDef(TypedDict):
    EndpointType: NotRequired[EndpointTypeType],  # (1)
    Endpoint: NotRequired[str],
  1. See EndpointTypeType

DescribeFaqRequestRequestTypeDef#

# DescribeFaqRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeFaqRequestRequestTypeDef

def get_value() -> DescribeFaqRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DescribeFaqRequestRequestTypeDef definition

class DescribeFaqRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DescribeFeaturedResultsSetRequestRequestTypeDef#

# DescribeFeaturedResultsSetRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeFeaturedResultsSetRequestRequestTypeDef

def get_value() -> DescribeFeaturedResultsSetRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "FeaturedResultsSetId": ...,
    }
# DescribeFeaturedResultsSetRequestRequestTypeDef definition

class DescribeFeaturedResultsSetRequestRequestTypeDef(TypedDict):
    IndexId: str,
    FeaturedResultsSetId: str,

FeaturedDocumentMissingTypeDef#

# FeaturedDocumentMissingTypeDef usage example

from mypy_boto3_kendra.type_defs import FeaturedDocumentMissingTypeDef

def get_value() -> FeaturedDocumentMissingTypeDef:
    return {
        "Id": ...,
    }
# FeaturedDocumentMissingTypeDef definition

class FeaturedDocumentMissingTypeDef(TypedDict):
    Id: NotRequired[str],

FeaturedDocumentWithMetadataTypeDef#

# FeaturedDocumentWithMetadataTypeDef usage example

from mypy_boto3_kendra.type_defs import FeaturedDocumentWithMetadataTypeDef

def get_value() -> FeaturedDocumentWithMetadataTypeDef:
    return {
        "Id": ...,
    }
# FeaturedDocumentWithMetadataTypeDef definition

class FeaturedDocumentWithMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Title: NotRequired[str],
    URI: NotRequired[str],

DescribeIndexRequestRequestTypeDef#

# DescribeIndexRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeIndexRequestRequestTypeDef

def get_value() -> DescribeIndexRequestRequestTypeDef:
    return {
        "Id": ...,
    }
# DescribeIndexRequestRequestTypeDef definition

class DescribeIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DescribePrincipalMappingRequestRequestTypeDef#

# DescribePrincipalMappingRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribePrincipalMappingRequestRequestTypeDef

def get_value() -> DescribePrincipalMappingRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "GroupId": ...,
    }
# DescribePrincipalMappingRequestRequestTypeDef definition

class DescribePrincipalMappingRequestRequestTypeDef(TypedDict):
    IndexId: str,
    GroupId: str,
    DataSourceId: NotRequired[str],

GroupOrderingIdSummaryTypeDef#

# GroupOrderingIdSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import GroupOrderingIdSummaryTypeDef

def get_value() -> GroupOrderingIdSummaryTypeDef:
    return {
        "Status": ...,
    }
# GroupOrderingIdSummaryTypeDef definition

class GroupOrderingIdSummaryTypeDef(TypedDict):
    Status: NotRequired[PrincipalMappingStatusType],  # (1)
    LastUpdatedAt: NotRequired[datetime],
    ReceivedAt: NotRequired[datetime],
    OrderingId: NotRequired[int],
    FailureReason: NotRequired[str],
  1. See PrincipalMappingStatusType

DescribeQuerySuggestionsBlockListRequestRequestTypeDef#

# DescribeQuerySuggestionsBlockListRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> DescribeQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
# DescribeQuerySuggestionsBlockListRequestRequestTypeDef definition

class DescribeQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,

DescribeQuerySuggestionsConfigRequestRequestTypeDef#

# DescribeQuerySuggestionsConfigRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeQuerySuggestionsConfigRequestRequestTypeDef

def get_value() -> DescribeQuerySuggestionsConfigRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# DescribeQuerySuggestionsConfigRequestRequestTypeDef definition

class DescribeQuerySuggestionsConfigRequestRequestTypeDef(TypedDict):
    IndexId: str,

DescribeThesaurusRequestRequestTypeDef#

# DescribeThesaurusRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeThesaurusRequestRequestTypeDef

def get_value() -> DescribeThesaurusRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# DescribeThesaurusRequestRequestTypeDef definition

class DescribeThesaurusRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

DisassociatePersonasFromEntitiesRequestRequestTypeDef#

# DisassociatePersonasFromEntitiesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DisassociatePersonasFromEntitiesRequestRequestTypeDef

def get_value() -> DisassociatePersonasFromEntitiesRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "EntityIds": ...,
    }
# DisassociatePersonasFromEntitiesRequestRequestTypeDef definition

class DisassociatePersonasFromEntitiesRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    EntityIds: Sequence[str],

DocumentAttributeValueTypeDef#

# DocumentAttributeValueTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentAttributeValueTypeDef

def get_value() -> DocumentAttributeValueTypeDef:
    return {
        "StringValue": ...,
    }
# DocumentAttributeValueTypeDef definition

class DocumentAttributeValueTypeDef(TypedDict):
    StringValue: NotRequired[str],
    StringListValue: NotRequired[Sequence[str]],
    LongValue: NotRequired[int],
    DateValue: NotRequired[Union[datetime, str]],

RelevanceTypeDef#

# RelevanceTypeDef usage example

from mypy_boto3_kendra.type_defs import RelevanceTypeDef

def get_value() -> RelevanceTypeDef:
    return {
        "Freshness": ...,
    }
# RelevanceTypeDef definition

class RelevanceTypeDef(TypedDict):
    Freshness: NotRequired[bool],
    Importance: NotRequired[int],
    Duration: NotRequired[str],
    RankOrder: NotRequired[OrderType],  # (1)
    ValueImportanceMap: NotRequired[Dict[str, int]],
  1. See OrderType

SearchTypeDef#

# SearchTypeDef usage example

from mypy_boto3_kendra.type_defs import SearchTypeDef

def get_value() -> SearchTypeDef:
    return {
        "Facetable": ...,
    }
# SearchTypeDef definition

class SearchTypeDef(TypedDict):
    Facetable: NotRequired[bool],
    Searchable: NotRequired[bool],
    Displayable: NotRequired[bool],
    Sortable: NotRequired[bool],

DocumentsMetadataConfigurationTypeDef#

# DocumentsMetadataConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentsMetadataConfigurationTypeDef

def get_value() -> DocumentsMetadataConfigurationTypeDef:
    return {
        "S3Prefix": ...,
    }
# DocumentsMetadataConfigurationTypeDef definition

class DocumentsMetadataConfigurationTypeDef(TypedDict):
    S3Prefix: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_kendra.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EntityDisplayDataTypeDef#

# EntityDisplayDataTypeDef usage example

from mypy_boto3_kendra.type_defs import EntityDisplayDataTypeDef

def get_value() -> EntityDisplayDataTypeDef:
    return {
        "UserName": ...,
    }
# EntityDisplayDataTypeDef definition

class EntityDisplayDataTypeDef(TypedDict):
    UserName: NotRequired[str],
    GroupName: NotRequired[str],
    IdentifiedUserName: NotRequired[str],
    FirstName: NotRequired[str],
    LastName: NotRequired[str],

UserIdentityConfigurationTypeDef#

# UserIdentityConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import UserIdentityConfigurationTypeDef

def get_value() -> UserIdentityConfigurationTypeDef:
    return {
        "IdentityAttributeName": ...,
    }
# UserIdentityConfigurationTypeDef definition

class UserIdentityConfigurationTypeDef(TypedDict):
    IdentityAttributeName: NotRequired[str],

FacetResultTypeDef#

# FacetResultTypeDef usage example

from mypy_boto3_kendra.type_defs import FacetResultTypeDef

def get_value() -> FacetResultTypeDef:
    return {
        "DocumentAttributeKey": ...,
    }
# FacetResultTypeDef definition

class FacetResultTypeDef(TypedDict):
    DocumentAttributeKey: NotRequired[str],
    DocumentAttributeValueType: NotRequired[DocumentAttributeValueTypeType],  # (1)
    DocumentAttributeValueCountPairs: NotRequired[List[DocumentAttributeValueCountPairTypeDef]],  # (2)
  1. See DocumentAttributeValueTypeType
  2. See DocumentAttributeValueCountPairTypeDef

FacetTypeDef#

# FacetTypeDef usage example

from mypy_boto3_kendra.type_defs import FacetTypeDef

def get_value() -> FacetTypeDef:
    return {
        "DocumentAttributeKey": ...,
    }
# FacetTypeDef definition

class FacetTypeDef(TypedDict):
    DocumentAttributeKey: NotRequired[str],
    Facets: NotRequired[Sequence[FacetTypeDef]],  # (1)
    MaxResults: NotRequired[int],
  1. See FacetTypeDef

FaqStatisticsTypeDef#

# FaqStatisticsTypeDef usage example

from mypy_boto3_kendra.type_defs import FaqStatisticsTypeDef

def get_value() -> FaqStatisticsTypeDef:
    return {
        "IndexedQuestionAnswersCount": ...,
    }
# FaqStatisticsTypeDef definition

class FaqStatisticsTypeDef(TypedDict):
    IndexedQuestionAnswersCount: int,

FaqSummaryTypeDef#

# FaqSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import FaqSummaryTypeDef

def get_value() -> FaqSummaryTypeDef:
    return {
        "Id": ...,
    }
# FaqSummaryTypeDef definition

class FaqSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[FaqStatusType],  # (1)
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
    FileFormat: NotRequired[FaqFileFormatType],  # (2)
    LanguageCode: NotRequired[str],
  1. See FaqStatusType
  2. See FaqFileFormatType

FeaturedResultsSetSummaryTypeDef#

# FeaturedResultsSetSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import FeaturedResultsSetSummaryTypeDef

def get_value() -> FeaturedResultsSetSummaryTypeDef:
    return {
        "FeaturedResultsSetId": ...,
    }
# FeaturedResultsSetSummaryTypeDef definition

class FeaturedResultsSetSummaryTypeDef(TypedDict):
    FeaturedResultsSetId: NotRequired[str],
    FeaturedResultsSetName: NotRequired[str],
    Status: NotRequired[FeaturedResultsSetStatusType],  # (1)
    LastUpdatedTimestamp: NotRequired[int],
    CreationTimestamp: NotRequired[int],
  1. See FeaturedResultsSetStatusType

GetSnapshotsRequestRequestTypeDef#

# GetSnapshotsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import GetSnapshotsRequestRequestTypeDef

def get_value() -> GetSnapshotsRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Interval": ...,
        "MetricType": ...,
    }
# GetSnapshotsRequestRequestTypeDef 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#

# TimeRangeTypeDef usage example

from mypy_boto3_kendra.type_defs import TimeRangeTypeDef

def get_value() -> TimeRangeTypeDef:
    return {
        "StartTime": ...,
    }
# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],

GitHubDocumentCrawlPropertiesTypeDef#

# GitHubDocumentCrawlPropertiesTypeDef usage example

from mypy_boto3_kendra.type_defs import GitHubDocumentCrawlPropertiesTypeDef

def get_value() -> GitHubDocumentCrawlPropertiesTypeDef:
    return {
        "CrawlRepositoryDocuments": ...,
    }
# GitHubDocumentCrawlPropertiesTypeDef definition

class GitHubDocumentCrawlPropertiesTypeDef(TypedDict):
    CrawlRepositoryDocuments: NotRequired[bool],
    CrawlIssue: NotRequired[bool],
    CrawlIssueComment: NotRequired[bool],
    CrawlIssueCommentAttachment: NotRequired[bool],
    CrawlPullRequest: NotRequired[bool],
    CrawlPullRequestComment: NotRequired[bool],
    CrawlPullRequestCommentAttachment: NotRequired[bool],

SaaSConfigurationTypeDef#

# SaaSConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SaaSConfigurationTypeDef

def get_value() -> SaaSConfigurationTypeDef:
    return {
        "OrganizationName": ...,
        "HostUrl": ...,
    }
# SaaSConfigurationTypeDef definition

class SaaSConfigurationTypeDef(TypedDict):
    OrganizationName: str,
    HostUrl: str,

MemberGroupTypeDef#

# MemberGroupTypeDef usage example

from mypy_boto3_kendra.type_defs import MemberGroupTypeDef

def get_value() -> MemberGroupTypeDef:
    return {
        "GroupId": ...,
    }
# MemberGroupTypeDef definition

class MemberGroupTypeDef(TypedDict):
    GroupId: str,
    DataSourceId: NotRequired[str],

MemberUserTypeDef#

# MemberUserTypeDef usage example

from mypy_boto3_kendra.type_defs import MemberUserTypeDef

def get_value() -> MemberUserTypeDef:
    return {
        "UserId": ...,
    }
# MemberUserTypeDef definition

class MemberUserTypeDef(TypedDict):
    UserId: str,

GroupSummaryTypeDef#

# GroupSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import GroupSummaryTypeDef

def get_value() -> GroupSummaryTypeDef:
    return {
        "GroupId": ...,
    }
# GroupSummaryTypeDef definition

class GroupSummaryTypeDef(TypedDict):
    GroupId: NotRequired[str],
    OrderingId: NotRequired[int],

HighlightTypeDef#

# HighlightTypeDef usage example

from mypy_boto3_kendra.type_defs import HighlightTypeDef

def get_value() -> HighlightTypeDef:
    return {
        "BeginOffset": ...,
        "EndOffset": ...,
    }
# HighlightTypeDef definition

class HighlightTypeDef(TypedDict):
    BeginOffset: int,
    EndOffset: int,
    TopAnswer: NotRequired[bool],
    Type: NotRequired[HighlightTypeType],  # (1)
  1. See HighlightTypeType

IndexConfigurationSummaryTypeDef#

# IndexConfigurationSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import IndexConfigurationSummaryTypeDef

def get_value() -> IndexConfigurationSummaryTypeDef:
    return {
        "CreatedAt": ...,
        "UpdatedAt": ...,
        "Status": ...,
    }
# IndexConfigurationSummaryTypeDef 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#

# TextDocumentStatisticsTypeDef usage example

from mypy_boto3_kendra.type_defs import TextDocumentStatisticsTypeDef

def get_value() -> TextDocumentStatisticsTypeDef:
    return {
        "IndexedTextDocumentsCount": ...,
        "IndexedTextBytes": ...,
    }
# TextDocumentStatisticsTypeDef definition

class TextDocumentStatisticsTypeDef(TypedDict):
    IndexedTextDocumentsCount: int,
    IndexedTextBytes: int,

JsonTokenTypeConfigurationTypeDef#

# JsonTokenTypeConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import JsonTokenTypeConfigurationTypeDef

def get_value() -> JsonTokenTypeConfigurationTypeDef:
    return {
        "UserNameAttributeField": ...,
        "GroupAttributeField": ...,
    }
# JsonTokenTypeConfigurationTypeDef definition

class JsonTokenTypeConfigurationTypeDef(TypedDict):
    UserNameAttributeField: str,
    GroupAttributeField: str,

JwtTokenTypeConfigurationTypeDef#

# JwtTokenTypeConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import JwtTokenTypeConfigurationTypeDef

def get_value() -> JwtTokenTypeConfigurationTypeDef:
    return {
        "KeyLocation": ...,
    }
# JwtTokenTypeConfigurationTypeDef definition

class JwtTokenTypeConfigurationTypeDef(TypedDict):
    KeyLocation: KeyLocationType,  # (1)
    URL: NotRequired[str],
    SecretManagerArn: NotRequired[str],
    UserNameAttributeField: NotRequired[str],
    GroupAttributeField: NotRequired[str],
    Issuer: NotRequired[str],
    ClaimRegex: NotRequired[str],
  1. See KeyLocationType

ListAccessControlConfigurationsRequestRequestTypeDef#

# ListAccessControlConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListAccessControlConfigurationsRequestRequestTypeDef

def get_value() -> ListAccessControlConfigurationsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListAccessControlConfigurationsRequestRequestTypeDef definition

class ListAccessControlConfigurationsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListDataSourcesRequestRequestTypeDef

def get_value() -> ListDataSourcesRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListDataSourcesRequestRequestTypeDef definition

class ListDataSourcesRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListEntityPersonasRequestRequestTypeDef#

# ListEntityPersonasRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListEntityPersonasRequestRequestTypeDef

def get_value() -> ListEntityPersonasRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# ListEntityPersonasRequestRequestTypeDef definition

class ListEntityPersonasRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PersonasSummaryTypeDef#

# PersonasSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import PersonasSummaryTypeDef

def get_value() -> PersonasSummaryTypeDef:
    return {
        "EntityId": ...,
    }
# PersonasSummaryTypeDef definition

class PersonasSummaryTypeDef(TypedDict):
    EntityId: NotRequired[str],
    Persona: NotRequired[PersonaType],  # (1)
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
  1. See PersonaType

ListExperienceEntitiesRequestRequestTypeDef#

# ListExperienceEntitiesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListExperienceEntitiesRequestRequestTypeDef

def get_value() -> ListExperienceEntitiesRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# ListExperienceEntitiesRequestRequestTypeDef definition

class ListExperienceEntitiesRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    NextToken: NotRequired[str],

ListExperiencesRequestRequestTypeDef#

# ListExperiencesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListExperiencesRequestRequestTypeDef

def get_value() -> ListExperiencesRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListExperiencesRequestRequestTypeDef definition

class ListExperiencesRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListFaqsRequestRequestTypeDef#

# ListFaqsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListFaqsRequestRequestTypeDef

def get_value() -> ListFaqsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListFaqsRequestRequestTypeDef definition

class ListFaqsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListFeaturedResultsSetsRequestRequestTypeDef#

# ListFeaturedResultsSetsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListFeaturedResultsSetsRequestRequestTypeDef

def get_value() -> ListFeaturedResultsSetsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListFeaturedResultsSetsRequestRequestTypeDef definition

class ListFeaturedResultsSetsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListGroupsOlderThanOrderingIdRequestRequestTypeDef#

# ListGroupsOlderThanOrderingIdRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListGroupsOlderThanOrderingIdRequestRequestTypeDef

def get_value() -> ListGroupsOlderThanOrderingIdRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "OrderingId": ...,
    }
# ListGroupsOlderThanOrderingIdRequestRequestTypeDef definition

class ListGroupsOlderThanOrderingIdRequestRequestTypeDef(TypedDict):
    IndexId: str,
    OrderingId: int,
    DataSourceId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListIndicesRequestRequestTypeDef#

# ListIndicesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListIndicesRequestRequestTypeDef

def get_value() -> ListIndicesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListIndicesRequestRequestTypeDef definition

class ListIndicesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListQuerySuggestionsBlockListsRequestRequestTypeDef#

# ListQuerySuggestionsBlockListsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListQuerySuggestionsBlockListsRequestRequestTypeDef

def get_value() -> ListQuerySuggestionsBlockListsRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListQuerySuggestionsBlockListsRequestRequestTypeDef definition

class ListQuerySuggestionsBlockListsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

QuerySuggestionsBlockListSummaryTypeDef#

# QuerySuggestionsBlockListSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import QuerySuggestionsBlockListSummaryTypeDef

def get_value() -> QuerySuggestionsBlockListSummaryTypeDef:
    return {
        "Id": ...,
    }
# QuerySuggestionsBlockListSummaryTypeDef definition

class QuerySuggestionsBlockListSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[QuerySuggestionsBlockListStatusType],  # (1)
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
    ItemCount: NotRequired[int],
  1. See QuerySuggestionsBlockListStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

ListThesauriRequestRequestTypeDef#

# ListThesauriRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListThesauriRequestRequestTypeDef

def get_value() -> ListThesauriRequestRequestTypeDef:
    return {
        "IndexId": ...,
    }
# ListThesauriRequestRequestTypeDef definition

class ListThesauriRequestRequestTypeDef(TypedDict):
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ThesaurusSummaryTypeDef#

# ThesaurusSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import ThesaurusSummaryTypeDef

def get_value() -> ThesaurusSummaryTypeDef:
    return {
        "Id": ...,
    }
# ThesaurusSummaryTypeDef definition

class ThesaurusSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[ThesaurusStatusType],  # (1)
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
  1. See ThesaurusStatusType

SortingConfigurationTypeDef#

# SortingConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SortingConfigurationTypeDef

def get_value() -> SortingConfigurationTypeDef:
    return {
        "DocumentAttributeKey": ...,
        "SortOrder": ...,
    }
# SortingConfigurationTypeDef definition

class SortingConfigurationTypeDef(TypedDict):
    DocumentAttributeKey: str,
    SortOrder: SortOrderType,  # (1)
  1. See SortOrderType

SpellCorrectionConfigurationTypeDef#

# SpellCorrectionConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SpellCorrectionConfigurationTypeDef

def get_value() -> SpellCorrectionConfigurationTypeDef:
    return {
        "IncludeQuerySpellCheckSuggestions": ...,
    }
# SpellCorrectionConfigurationTypeDef definition

class SpellCorrectionConfigurationTypeDef(TypedDict):
    IncludeQuerySpellCheckSuggestions: bool,

ScoreAttributesTypeDef#

# ScoreAttributesTypeDef usage example

from mypy_boto3_kendra.type_defs import ScoreAttributesTypeDef

def get_value() -> ScoreAttributesTypeDef:
    return {
        "ScoreConfidence": ...,
    }
# ScoreAttributesTypeDef definition

class ScoreAttributesTypeDef(TypedDict):
    ScoreConfidence: NotRequired[ScoreConfidenceType],  # (1)
  1. See ScoreConfidenceType

WarningTypeDef#

# WarningTypeDef usage example

from mypy_boto3_kendra.type_defs import WarningTypeDef

def get_value() -> WarningTypeDef:
    return {
        "Message": ...,
    }
# WarningTypeDef definition

class WarningTypeDef(TypedDict):
    Message: NotRequired[str],
    Code: NotRequired[WarningCodeType],  # (1)
  1. See WarningCodeType

RelevanceFeedbackTypeDef#

# RelevanceFeedbackTypeDef usage example

from mypy_boto3_kendra.type_defs import RelevanceFeedbackTypeDef

def get_value() -> RelevanceFeedbackTypeDef:
    return {
        "ResultId": ...,
        "RelevanceValue": ...,
    }
# RelevanceFeedbackTypeDef definition

class RelevanceFeedbackTypeDef(TypedDict):
    ResultId: str,
    RelevanceValue: RelevanceTypeType,  # (1)
  1. See RelevanceTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_kendra.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SeedUrlConfigurationTypeDef#

# SeedUrlConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SeedUrlConfigurationTypeDef

def get_value() -> SeedUrlConfigurationTypeDef:
    return {
        "SeedUrls": ...,
    }
# SeedUrlConfigurationTypeDef definition

class SeedUrlConfigurationTypeDef(TypedDict):
    SeedUrls: Sequence[str],
    WebCrawlerMode: NotRequired[WebCrawlerModeType],  # (1)
  1. See WebCrawlerModeType

SiteMapsConfigurationTypeDef#

# SiteMapsConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SiteMapsConfigurationTypeDef

def get_value() -> SiteMapsConfigurationTypeDef:
    return {
        "SiteMaps": ...,
    }
# SiteMapsConfigurationTypeDef definition

class SiteMapsConfigurationTypeDef(TypedDict):
    SiteMaps: Sequence[str],

StartDataSourceSyncJobRequestRequestTypeDef#

# StartDataSourceSyncJobRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import StartDataSourceSyncJobRequestRequestTypeDef

def get_value() -> StartDataSourceSyncJobRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# StartDataSourceSyncJobRequestRequestTypeDef definition

class StartDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

StartDataSourceSyncJobResponseTypeDef#

# StartDataSourceSyncJobResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import StartDataSourceSyncJobResponseTypeDef

def get_value() -> StartDataSourceSyncJobResponseTypeDef:
    return {
        "ExecutionId": ...,
        "ResponseMetadata": ...,
    }
# StartDataSourceSyncJobResponseTypeDef definition

class StartDataSourceSyncJobResponseTypeDef(TypedDict):
    ExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopDataSourceSyncJobRequestRequestTypeDef#

# StopDataSourceSyncJobRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import StopDataSourceSyncJobRequestRequestTypeDef

def get_value() -> StopDataSourceSyncJobRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# StopDataSourceSyncJobRequestRequestTypeDef definition

class StopDataSourceSyncJobRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,

SuggestionHighlightTypeDef#

# SuggestionHighlightTypeDef usage example

from mypy_boto3_kendra.type_defs import SuggestionHighlightTypeDef

def get_value() -> SuggestionHighlightTypeDef:
    return {
        "BeginOffset": ...,
    }
# SuggestionHighlightTypeDef definition

class SuggestionHighlightTypeDef(TypedDict):
    BeginOffset: NotRequired[int],
    EndOffset: NotRequired[int],

TableCellTypeDef#

# TableCellTypeDef usage example

from mypy_boto3_kendra.type_defs import TableCellTypeDef

def get_value() -> TableCellTypeDef:
    return {
        "Value": ...,
    }
# TableCellTypeDef definition

class TableCellTypeDef(TypedDict):
    Value: NotRequired[str],
    TopAnswer: NotRequired[bool],
    Highlighted: NotRequired[bool],
    Header: NotRequired[bool],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

ListAccessControlConfigurationsResponseTypeDef#

# ListAccessControlConfigurationsResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListAccessControlConfigurationsResponseTypeDef

def get_value() -> ListAccessControlConfigurationsResponseTypeDef:
    return {
        "NextToken": ...,
        "AccessControlConfigurations": ...,
        "ResponseMetadata": ...,
    }
# ListAccessControlConfigurationsResponseTypeDef definition

class ListAccessControlConfigurationsResponseTypeDef(TypedDict):
    NextToken: str,
    AccessControlConfigurations: List[AccessControlConfigurationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessControlConfigurationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ColumnConfigurationTypeDef#

# ColumnConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ColumnConfigurationTypeDef

def get_value() -> ColumnConfigurationTypeDef:
    return {
        "DocumentIdColumnName": ...,
        "DocumentDataColumnName": ...,
        "ChangeDetectingColumns": ...,
    }
# ColumnConfigurationTypeDef definition

class ColumnConfigurationTypeDef(TypedDict):
    DocumentIdColumnName: str,
    DocumentDataColumnName: str,
    ChangeDetectingColumns: Sequence[str],
    DocumentTitleColumnName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

GoogleDriveConfigurationTypeDef#

# GoogleDriveConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import GoogleDriveConfigurationTypeDef

def get_value() -> GoogleDriveConfigurationTypeDef:
    return {
        "SecretArn": ...,
    }
# GoogleDriveConfigurationTypeDef definition

class GoogleDriveConfigurationTypeDef(TypedDict):
    SecretArn: str,
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    ExcludeMimeTypes: NotRequired[Sequence[str]],
    ExcludeUserAccounts: NotRequired[Sequence[str]],
    ExcludeSharedDrives: NotRequired[Sequence[str]],
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceChatterFeedConfigurationTypeDef#

# SalesforceChatterFeedConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SalesforceChatterFeedConfigurationTypeDef

def get_value() -> SalesforceChatterFeedConfigurationTypeDef:
    return {
        "DocumentDataFieldName": ...,
    }
# SalesforceChatterFeedConfigurationTypeDef definition

class SalesforceChatterFeedConfigurationTypeDef(TypedDict):
    DocumentDataFieldName: str,
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    IncludeFilterTypes: NotRequired[Sequence[SalesforceChatterFeedIncludeFilterTypeType]],  # (2)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See SalesforceChatterFeedIncludeFilterTypeType

SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef#

# SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef

def get_value() -> SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef:
    return {
        "Name": ...,
        "DocumentDataFieldName": ...,
    }
# SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef definition

class SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
    Name: str,
    DocumentDataFieldName: str,
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef#

# SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef

def get_value() -> SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef:
    return {
        "DocumentDataFieldName": ...,
    }
# SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef definition

class SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef(TypedDict):
    DocumentDataFieldName: str,
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardObjectAttachmentConfigurationTypeDef#

# SalesforceStandardObjectAttachmentConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SalesforceStandardObjectAttachmentConfigurationTypeDef

def get_value() -> SalesforceStandardObjectAttachmentConfigurationTypeDef:
    return {
        "DocumentTitleFieldName": ...,
    }
# SalesforceStandardObjectAttachmentConfigurationTypeDef definition

class SalesforceStandardObjectAttachmentConfigurationTypeDef(TypedDict):
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

SalesforceStandardObjectConfigurationTypeDef#

# SalesforceStandardObjectConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SalesforceStandardObjectConfigurationTypeDef

def get_value() -> SalesforceStandardObjectConfigurationTypeDef:
    return {
        "Name": ...,
        "DocumentDataFieldName": ...,
    }
# SalesforceStandardObjectConfigurationTypeDef definition

class SalesforceStandardObjectConfigurationTypeDef(TypedDict):
    Name: SalesforceStandardObjectNameType,  # (1)
    DocumentDataFieldName: str,
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
  1. See SalesforceStandardObjectNameType
  2. See DataSourceToIndexFieldMappingTypeDef

ServiceNowKnowledgeArticleConfigurationTypeDef#

# ServiceNowKnowledgeArticleConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ServiceNowKnowledgeArticleConfigurationTypeDef

def get_value() -> ServiceNowKnowledgeArticleConfigurationTypeDef:
    return {
        "DocumentDataFieldName": ...,
    }
# ServiceNowKnowledgeArticleConfigurationTypeDef definition

class ServiceNowKnowledgeArticleConfigurationTypeDef(TypedDict):
    DocumentDataFieldName: str,
    CrawlAttachments: NotRequired[bool],
    IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
    ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    FilterQuery: NotRequired[str],
  1. See DataSourceToIndexFieldMappingTypeDef

ServiceNowServiceCatalogConfigurationTypeDef#

# ServiceNowServiceCatalogConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ServiceNowServiceCatalogConfigurationTypeDef

def get_value() -> ServiceNowServiceCatalogConfigurationTypeDef:
    return {
        "DocumentDataFieldName": ...,
    }
# ServiceNowServiceCatalogConfigurationTypeDef definition

class ServiceNowServiceCatalogConfigurationTypeDef(TypedDict):
    DocumentDataFieldName: str,
    CrawlAttachments: NotRequired[bool],
    IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
    ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],
    DocumentTitleFieldName: NotRequired[str],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

WorkDocsConfigurationTypeDef#

# WorkDocsConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import WorkDocsConfigurationTypeDef

def get_value() -> WorkDocsConfigurationTypeDef:
    return {
        "OrganizationId": ...,
    }
# WorkDocsConfigurationTypeDef definition

class WorkDocsConfigurationTypeDef(TypedDict):
    OrganizationId: str,
    CrawlComments: NotRequired[bool],
    UseChangeLog: NotRequired[bool],
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
  1. See DataSourceToIndexFieldMappingTypeDef

BoxConfigurationTypeDef#

# BoxConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import BoxConfigurationTypeDef

def get_value() -> BoxConfigurationTypeDef:
    return {
        "EnterpriseId": ...,
        "SecretArn": ...,
    }
# BoxConfigurationTypeDef definition

class BoxConfigurationTypeDef(TypedDict):
    EnterpriseId: str,
    SecretArn: str,
    UseChangeLog: NotRequired[bool],
    CrawlComments: NotRequired[bool],
    CrawlTasks: NotRequired[bool],
    CrawlWebLinks: NotRequired[bool],
    FileFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    TaskFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    CommentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    WebLinkFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (5)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceVpcConfigurationTypeDef

FsxConfigurationTypeDef#

# FsxConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import FsxConfigurationTypeDef

def get_value() -> FsxConfigurationTypeDef:
    return {
        "FileSystemId": ...,
        "FileSystemType": ...,
        "VpcConfiguration": ...,
    }
# FsxConfigurationTypeDef definition

class FsxConfigurationTypeDef(TypedDict):
    FileSystemId: str,
    FileSystemType: FsxFileSystemTypeType,  # (1)
    VpcConfiguration: DataSourceVpcConfigurationTypeDef,  # (2)
    SecretArn: NotRequired[str],
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
  1. See FsxFileSystemTypeType
  2. See DataSourceVpcConfigurationTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef

JiraConfigurationTypeDef#

# JiraConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import JiraConfigurationTypeDef

def get_value() -> JiraConfigurationTypeDef:
    return {
        "JiraAccountUrl": ...,
        "SecretArn": ...,
    }
# JiraConfigurationTypeDef definition

class JiraConfigurationTypeDef(TypedDict):
    JiraAccountUrl: str,
    SecretArn: str,
    UseChangeLog: NotRequired[bool],
    Project: NotRequired[Sequence[str]],
    IssueType: NotRequired[Sequence[str]],
    Status: NotRequired[Sequence[str]],
    IssueSubEntityFilter: NotRequired[Sequence[IssueSubEntityType]],  # (1)
    AttachmentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    CommentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    IssueFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    ProjectFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    WorkLogFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (7)
  1. See IssueSubEntityType
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceToIndexFieldMappingTypeDef
  6. See DataSourceToIndexFieldMappingTypeDef
  7. See DataSourceVpcConfigurationTypeDef

QuipConfigurationTypeDef#

# QuipConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import QuipConfigurationTypeDef

def get_value() -> QuipConfigurationTypeDef:
    return {
        "Domain": ...,
        "SecretArn": ...,
    }
# QuipConfigurationTypeDef definition

class QuipConfigurationTypeDef(TypedDict):
    Domain: str,
    SecretArn: str,
    CrawlFileComments: NotRequired[bool],
    CrawlChatRooms: NotRequired[bool],
    CrawlAttachments: NotRequired[bool],
    FolderIds: NotRequired[Sequence[str]],
    ThreadFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    MessageFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    AttachmentFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (1)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (4)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceVpcConfigurationTypeDef

SlackConfigurationTypeDef#

# SlackConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SlackConfigurationTypeDef

def get_value() -> SlackConfigurationTypeDef:
    return {
        "TeamId": ...,
        "SecretArn": ...,
        "SlackEntityList": ...,
        "SinceCrawlDate": ...,
    }
# SlackConfigurationTypeDef definition

class SlackConfigurationTypeDef(TypedDict):
    TeamId: str,
    SecretArn: str,
    SlackEntityList: Sequence[SlackEntityType],  # (2)
    SinceCrawlDate: str,
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (1)
    UseChangeLog: NotRequired[bool],
    CrawlBotMessage: NotRequired[bool],
    ExcludeArchived: NotRequired[bool],
    LookBackPeriod: NotRequired[int],
    PrivateChannelFilter: NotRequired[Sequence[str]],
    PublicChannelFilter: NotRequired[Sequence[str]],
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
  1. See DataSourceVpcConfigurationTypeDef
  2. See SlackEntityType
  3. See DataSourceToIndexFieldMappingTypeDef

AlfrescoConfigurationTypeDef#

# AlfrescoConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import AlfrescoConfigurationTypeDef

def get_value() -> AlfrescoConfigurationTypeDef:
    return {
        "SiteUrl": ...,
        "SiteId": ...,
        "SecretArn": ...,
        "SslCertificateS3Path": ...,
    }
# AlfrescoConfigurationTypeDef definition

class AlfrescoConfigurationTypeDef(TypedDict):
    SiteUrl: str,
    SiteId: str,
    SecretArn: str,
    SslCertificateS3Path: S3PathTypeDef,  # (1)
    CrawlSystemFolders: NotRequired[bool],
    CrawlComments: NotRequired[bool],
    EntityFilter: NotRequired[Sequence[AlfrescoEntityType]],  # (2)
    DocumentLibraryFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
    BlogFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
    WikiFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (6)
  1. See S3PathTypeDef
  2. See AlfrescoEntityType
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceToIndexFieldMappingTypeDef
  6. See DataSourceVpcConfigurationTypeDef

DescribeFaqResponseTypeDef#

# DescribeFaqResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeFaqResponseTypeDef

def get_value() -> DescribeFaqResponseTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "Name": ...,
        "Description": ...,
        "CreatedAt": ...,
        "UpdatedAt": ...,
        "S3Path": ...,
        "Status": ...,
        "RoleArn": ...,
        "ErrorMessage": ...,
        "FileFormat": ...,
        "LanguageCode": ...,
        "ResponseMetadata": ...,
    }
# DescribeFaqResponseTypeDef 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)
  1. See S3PathTypeDef
  2. See FaqStatusType
  3. See FaqFileFormatType
  4. See ResponseMetadataTypeDef

DescribeQuerySuggestionsBlockListResponseTypeDef#

# DescribeQuerySuggestionsBlockListResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeQuerySuggestionsBlockListResponseTypeDef

def get_value() -> DescribeQuerySuggestionsBlockListResponseTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
        "Name": ...,
        "Description": ...,
        "Status": ...,
        "ErrorMessage": ...,
        "CreatedAt": ...,
        "UpdatedAt": ...,
        "SourceS3Path": ...,
        "ItemCount": ...,
        "FileSizeBytes": ...,
        "RoleArn": ...,
        "ResponseMetadata": ...,
    }
# DescribeQuerySuggestionsBlockListResponseTypeDef 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)
  1. See QuerySuggestionsBlockListStatusType
  2. See S3PathTypeDef
  3. See ResponseMetadataTypeDef

DescribeThesaurusResponseTypeDef#

# DescribeThesaurusResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeThesaurusResponseTypeDef

def get_value() -> DescribeThesaurusResponseTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "Name": ...,
        "Description": ...,
        "Status": ...,
        "ErrorMessage": ...,
        "CreatedAt": ...,
        "UpdatedAt": ...,
        "RoleArn": ...,
        "SourceS3Path": ...,
        "FileSizeBytes": ...,
        "TermCount": ...,
        "SynonymRuleCount": ...,
        "ResponseMetadata": ...,
    }
# DescribeThesaurusResponseTypeDef 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)
  1. See ThesaurusStatusType
  2. See S3PathTypeDef
  3. See ResponseMetadataTypeDef

OnPremiseConfigurationTypeDef#

# OnPremiseConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import OnPremiseConfigurationTypeDef

def get_value() -> OnPremiseConfigurationTypeDef:
    return {
        "HostUrl": ...,
        "OrganizationName": ...,
        "SslCertificateS3Path": ...,
    }
# OnPremiseConfigurationTypeDef definition

class OnPremiseConfigurationTypeDef(TypedDict):
    HostUrl: str,
    OrganizationName: str,
    SslCertificateS3Path: S3PathTypeDef,  # (1)
  1. See S3PathTypeDef

OneDriveUsersTypeDef#

# OneDriveUsersTypeDef usage example

from mypy_boto3_kendra.type_defs import OneDriveUsersTypeDef

def get_value() -> OneDriveUsersTypeDef:
    return {
        "OneDriveUserList": ...,
    }
# OneDriveUsersTypeDef definition

class OneDriveUsersTypeDef(TypedDict):
    OneDriveUserList: NotRequired[Sequence[str]],
    OneDriveUserS3Path: NotRequired[S3PathTypeDef],  # (1)
  1. See S3PathTypeDef

UpdateQuerySuggestionsBlockListRequestRequestTypeDef#

# UpdateQuerySuggestionsBlockListRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import UpdateQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> UpdateQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Id": ...,
    }
# UpdateQuerySuggestionsBlockListRequestRequestTypeDef definition

class UpdateQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    SourceS3Path: NotRequired[S3PathTypeDef],  # (1)
    RoleArn: NotRequired[str],
  1. See S3PathTypeDef

UpdateThesaurusRequestRequestTypeDef#

# UpdateThesaurusRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import UpdateThesaurusRequestRequestTypeDef

def get_value() -> UpdateThesaurusRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# UpdateThesaurusRequestRequestTypeDef definition

class UpdateThesaurusRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    RoleArn: NotRequired[str],
    SourceS3Path: NotRequired[S3PathTypeDef],  # (1)
  1. See S3PathTypeDef

AssociateEntitiesToExperienceRequestRequestTypeDef#

# AssociateEntitiesToExperienceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import AssociateEntitiesToExperienceRequestRequestTypeDef

def get_value() -> AssociateEntitiesToExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "EntityList": ...,
    }
# AssociateEntitiesToExperienceRequestRequestTypeDef definition

class AssociateEntitiesToExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
  1. See EntityConfigurationTypeDef

DisassociateEntitiesFromExperienceRequestRequestTypeDef#

# DisassociateEntitiesFromExperienceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import DisassociateEntitiesFromExperienceRequestRequestTypeDef

def get_value() -> DisassociateEntitiesFromExperienceRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "EntityList": ...,
    }
# DisassociateEntitiesFromExperienceRequestRequestTypeDef definition

class DisassociateEntitiesFromExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
  1. See EntityConfigurationTypeDef

AssociateEntitiesToExperienceResponseTypeDef#

# AssociateEntitiesToExperienceResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import AssociateEntitiesToExperienceResponseTypeDef

def get_value() -> AssociateEntitiesToExperienceResponseTypeDef:
    return {
        "FailedEntityList": ...,
        "ResponseMetadata": ...,
    }
# AssociateEntitiesToExperienceResponseTypeDef definition

class AssociateEntitiesToExperienceResponseTypeDef(TypedDict):
    FailedEntityList: List[FailedEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedEntityTypeDef
  2. See ResponseMetadataTypeDef

AssociatePersonasToEntitiesResponseTypeDef#

# AssociatePersonasToEntitiesResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import AssociatePersonasToEntitiesResponseTypeDef

def get_value() -> AssociatePersonasToEntitiesResponseTypeDef:
    return {
        "FailedEntityList": ...,
        "ResponseMetadata": ...,
    }
# AssociatePersonasToEntitiesResponseTypeDef definition

class AssociatePersonasToEntitiesResponseTypeDef(TypedDict):
    FailedEntityList: List[FailedEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedEntityTypeDef
  2. See ResponseMetadataTypeDef

DisassociateEntitiesFromExperienceResponseTypeDef#

# DisassociateEntitiesFromExperienceResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DisassociateEntitiesFromExperienceResponseTypeDef

def get_value() -> DisassociateEntitiesFromExperienceResponseTypeDef:
    return {
        "FailedEntityList": ...,
        "ResponseMetadata": ...,
    }
# DisassociateEntitiesFromExperienceResponseTypeDef definition

class DisassociateEntitiesFromExperienceResponseTypeDef(TypedDict):
    FailedEntityList: List[FailedEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedEntityTypeDef
  2. See ResponseMetadataTypeDef

DisassociatePersonasFromEntitiesResponseTypeDef#

# DisassociatePersonasFromEntitiesResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DisassociatePersonasFromEntitiesResponseTypeDef

def get_value() -> DisassociatePersonasFromEntitiesResponseTypeDef:
    return {
        "FailedEntityList": ...,
        "ResponseMetadata": ...,
    }
# DisassociatePersonasFromEntitiesResponseTypeDef definition

class DisassociatePersonasFromEntitiesResponseTypeDef(TypedDict):
    FailedEntityList: List[FailedEntityTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FailedEntityTypeDef
  2. See ResponseMetadataTypeDef

AssociatePersonasToEntitiesRequestRequestTypeDef#

# AssociatePersonasToEntitiesRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import AssociatePersonasToEntitiesRequestRequestTypeDef

def get_value() -> AssociatePersonasToEntitiesRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
        "Personas": ...,
    }
# AssociatePersonasToEntitiesRequestRequestTypeDef definition

class AssociatePersonasToEntitiesRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Personas: Sequence[EntityPersonaConfigurationTypeDef],  # (1)
  1. See EntityPersonaConfigurationTypeDef

AttributeSuggestionsDescribeConfigTypeDef#

# AttributeSuggestionsDescribeConfigTypeDef usage example

from mypy_boto3_kendra.type_defs import AttributeSuggestionsDescribeConfigTypeDef

def get_value() -> AttributeSuggestionsDescribeConfigTypeDef:
    return {
        "SuggestableConfigList": ...,
    }
# AttributeSuggestionsDescribeConfigTypeDef definition

class AttributeSuggestionsDescribeConfigTypeDef(TypedDict):
    SuggestableConfigList: NotRequired[List[SuggestableConfigTypeDef]],  # (1)
    AttributeSuggestionsMode: NotRequired[AttributeSuggestionsModeType],  # (2)
  1. See SuggestableConfigTypeDef
  2. See AttributeSuggestionsModeType

AttributeSuggestionsUpdateConfigTypeDef#

# AttributeSuggestionsUpdateConfigTypeDef usage example

from mypy_boto3_kendra.type_defs import AttributeSuggestionsUpdateConfigTypeDef

def get_value() -> AttributeSuggestionsUpdateConfigTypeDef:
    return {
        "SuggestableConfigList": ...,
    }
# AttributeSuggestionsUpdateConfigTypeDef definition

class AttributeSuggestionsUpdateConfigTypeDef(TypedDict):
    SuggestableConfigList: NotRequired[Sequence[SuggestableConfigTypeDef]],  # (1)
    AttributeSuggestionsMode: NotRequired[AttributeSuggestionsModeType],  # (2)
  1. See SuggestableConfigTypeDef
  2. See AttributeSuggestionsModeType

AuthenticationConfigurationTypeDef#

# AuthenticationConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import AuthenticationConfigurationTypeDef

def get_value() -> AuthenticationConfigurationTypeDef:
    return {
        "BasicAuthentication": ...,
    }
# AuthenticationConfigurationTypeDef definition

class AuthenticationConfigurationTypeDef(TypedDict):
    BasicAuthentication: NotRequired[Sequence[BasicAuthenticationConfigurationTypeDef]],  # (1)
  1. See BasicAuthenticationConfigurationTypeDef

BatchDeleteDocumentRequestRequestTypeDef#

# BatchDeleteDocumentRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteDocumentRequestRequestTypeDef

def get_value() -> BatchDeleteDocumentRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "DocumentIdList": ...,
    }
# BatchDeleteDocumentRequestRequestTypeDef definition

class BatchDeleteDocumentRequestRequestTypeDef(TypedDict):
    IndexId: str,
    DocumentIdList: Sequence[str],
    DataSourceSyncJobMetricTarget: NotRequired[DataSourceSyncJobMetricTargetTypeDef],  # (1)
  1. See DataSourceSyncJobMetricTargetTypeDef

BatchDeleteDocumentResponseTypeDef#

# BatchDeleteDocumentResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteDocumentResponseTypeDef

def get_value() -> BatchDeleteDocumentResponseTypeDef:
    return {
        "FailedDocuments": ...,
        "ResponseMetadata": ...,
    }
# BatchDeleteDocumentResponseTypeDef definition

class BatchDeleteDocumentResponseTypeDef(TypedDict):
    FailedDocuments: List[BatchDeleteDocumentResponseFailedDocumentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteDocumentResponseFailedDocumentTypeDef
  2. See ResponseMetadataTypeDef

BatchDeleteFeaturedResultsSetResponseTypeDef#

# BatchDeleteFeaturedResultsSetResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchDeleteFeaturedResultsSetResponseTypeDef

def get_value() -> BatchDeleteFeaturedResultsSetResponseTypeDef:
    return {
        "Errors": ...,
        "ResponseMetadata": ...,
    }
# BatchDeleteFeaturedResultsSetResponseTypeDef definition

class BatchDeleteFeaturedResultsSetResponseTypeDef(TypedDict):
    Errors: List[BatchDeleteFeaturedResultsSetErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteFeaturedResultsSetErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchGetDocumentStatusResponseTypeDef#

# BatchGetDocumentStatusResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchGetDocumentStatusResponseTypeDef

def get_value() -> BatchGetDocumentStatusResponseTypeDef:
    return {
        "Errors": ...,
        "DocumentStatusList": ...,
        "ResponseMetadata": ...,
    }
# BatchGetDocumentStatusResponseTypeDef definition

class BatchGetDocumentStatusResponseTypeDef(TypedDict):
    Errors: List[BatchGetDocumentStatusResponseErrorTypeDef],  # (1)
    DocumentStatusList: List[StatusTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchGetDocumentStatusResponseErrorTypeDef
  2. See StatusTypeDef
  3. See ResponseMetadataTypeDef

BatchPutDocumentResponseTypeDef#

# BatchPutDocumentResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import BatchPutDocumentResponseTypeDef

def get_value() -> BatchPutDocumentResponseTypeDef:
    return {
        "FailedDocuments": ...,
        "ResponseMetadata": ...,
    }
# BatchPutDocumentResponseTypeDef definition

class BatchPutDocumentResponseTypeDef(TypedDict):
    FailedDocuments: List[BatchPutDocumentResponseFailedDocumentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchPutDocumentResponseFailedDocumentTypeDef
  2. See ResponseMetadataTypeDef

ConfluenceAttachmentConfigurationTypeDef#

# ConfluenceAttachmentConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceAttachmentConfigurationTypeDef

def get_value() -> ConfluenceAttachmentConfigurationTypeDef:
    return {
        "CrawlAttachments": ...,
    }
# ConfluenceAttachmentConfigurationTypeDef definition

class ConfluenceAttachmentConfigurationTypeDef(TypedDict):
    CrawlAttachments: NotRequired[bool],
    AttachmentFieldMappings: NotRequired[Sequence[ConfluenceAttachmentToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluenceAttachmentToIndexFieldMappingTypeDef

ConfluenceBlogConfigurationTypeDef#

# ConfluenceBlogConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceBlogConfigurationTypeDef

def get_value() -> ConfluenceBlogConfigurationTypeDef:
    return {
        "BlogFieldMappings": ...,
    }
# ConfluenceBlogConfigurationTypeDef definition

class ConfluenceBlogConfigurationTypeDef(TypedDict):
    BlogFieldMappings: NotRequired[Sequence[ConfluenceBlogToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluenceBlogToIndexFieldMappingTypeDef

SharePointConfigurationTypeDef#

# SharePointConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import SharePointConfigurationTypeDef

def get_value() -> SharePointConfigurationTypeDef:
    return {
        "SharePointVersion": ...,
        "Urls": ...,
        "SecretArn": ...,
    }
# SharePointConfigurationTypeDef definition

class SharePointConfigurationTypeDef(TypedDict):
    SharePointVersion: SharePointVersionType,  # (1)
    Urls: Sequence[str],
    SecretArn: str,
    CrawlAttachments: NotRequired[bool],
    UseChangeLog: NotRequired[bool],
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (2)
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (3)
    DocumentTitleFieldName: NotRequired[str],
    DisableLocalGroups: NotRequired[bool],
    SslCertificateS3Path: NotRequired[S3PathTypeDef],  # (4)
    AuthenticationType: NotRequired[SharePointOnlineAuthenticationTypeType],  # (5)
    ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef],  # (6)
  1. See SharePointVersionType
  2. See DataSourceVpcConfigurationTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See S3PathTypeDef
  5. See SharePointOnlineAuthenticationTypeType
  6. See ProxyConfigurationTypeDef

ConfluencePageConfigurationTypeDef#

# ConfluencePageConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluencePageConfigurationTypeDef

def get_value() -> ConfluencePageConfigurationTypeDef:
    return {
        "PageFieldMappings": ...,
    }
# ConfluencePageConfigurationTypeDef definition

class ConfluencePageConfigurationTypeDef(TypedDict):
    PageFieldMappings: NotRequired[Sequence[ConfluencePageToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluencePageToIndexFieldMappingTypeDef

ConfluenceSpaceConfigurationTypeDef#

# ConfluenceSpaceConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ConfluenceSpaceConfigurationTypeDef

def get_value() -> ConfluenceSpaceConfigurationTypeDef:
    return {
        "CrawlPersonalSpaces": ...,
    }
# ConfluenceSpaceConfigurationTypeDef definition

class ConfluenceSpaceConfigurationTypeDef(TypedDict):
    CrawlPersonalSpaces: NotRequired[bool],
    CrawlArchivedSpaces: NotRequired[bool],
    IncludeSpaces: NotRequired[Sequence[str]],
    ExcludeSpaces: NotRequired[Sequence[str]],
    SpaceFieldMappings: NotRequired[Sequence[ConfluenceSpaceToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluenceSpaceToIndexFieldMappingTypeDef

SpellCorrectedQueryTypeDef#

# SpellCorrectedQueryTypeDef usage example

from mypy_boto3_kendra.type_defs import SpellCorrectedQueryTypeDef

def get_value() -> SpellCorrectedQueryTypeDef:
    return {
        "SuggestedQueryText": ...,
    }
# SpellCorrectedQueryTypeDef definition

class SpellCorrectedQueryTypeDef(TypedDict):
    SuggestedQueryText: NotRequired[str],
    Corrections: NotRequired[List[CorrectionTypeDef]],  # (1)
  1. See CorrectionTypeDef

HierarchicalPrincipalTypeDef#

# HierarchicalPrincipalTypeDef usage example

from mypy_boto3_kendra.type_defs import HierarchicalPrincipalTypeDef

def get_value() -> HierarchicalPrincipalTypeDef:
    return {
        "PrincipalList": ...,
    }
# HierarchicalPrincipalTypeDef definition

class HierarchicalPrincipalTypeDef(TypedDict):
    PrincipalList: Sequence[PrincipalTypeDef],  # (1)
  1. See PrincipalTypeDef

CreateFaqRequestRequestTypeDef#

# CreateFaqRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateFaqRequestRequestTypeDef

def get_value() -> CreateFaqRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Name": ...,
        "S3Path": ...,
        "RoleArn": ...,
    }
# CreateFaqRequestRequestTypeDef 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],
  1. See S3PathTypeDef
  2. See TagTypeDef
  3. See FaqFileFormatType

CreateQuerySuggestionsBlockListRequestRequestTypeDef#

# CreateQuerySuggestionsBlockListRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateQuerySuggestionsBlockListRequestRequestTypeDef

def get_value() -> CreateQuerySuggestionsBlockListRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Name": ...,
        "SourceS3Path": ...,
        "RoleArn": ...,
    }
# CreateQuerySuggestionsBlockListRequestRequestTypeDef definition

class CreateQuerySuggestionsBlockListRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Name: str,
    SourceS3Path: S3PathTypeDef,  # (1)
    RoleArn: str,
    Description: NotRequired[str],
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See S3PathTypeDef
  2. See TagTypeDef

CreateThesaurusRequestRequestTypeDef#

# CreateThesaurusRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateThesaurusRequestRequestTypeDef

def get_value() -> CreateThesaurusRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "Name": ...,
        "RoleArn": ...,
        "SourceS3Path": ...,
    }
# CreateThesaurusRequestRequestTypeDef definition

class CreateThesaurusRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Name: str,
    RoleArn: str,
    SourceS3Path: S3PathTypeDef,  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    ClientToken: NotRequired[str],
  1. See S3PathTypeDef
  2. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateFeaturedResultsSetRequestRequestTypeDef#

# CreateFeaturedResultsSetRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import CreateFeaturedResultsSetRequestRequestTypeDef

def get_value() -> CreateFeaturedResultsSetRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "FeaturedResultsSetName": ...,
    }
# CreateFeaturedResultsSetRequestRequestTypeDef definition

class CreateFeaturedResultsSetRequestRequestTypeDef(TypedDict):
    IndexId: str,
    FeaturedResultsSetName: str,
    Description: NotRequired[str],
    ClientToken: NotRequired[str],
    Status: NotRequired[FeaturedResultsSetStatusType],  # (1)
    QueryTexts: NotRequired[Sequence[str]],
    FeaturedDocuments: NotRequired[Sequence[FeaturedDocumentTypeDef]],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See FeaturedResultsSetStatusType
  2. See FeaturedDocumentTypeDef
  3. See TagTypeDef

FeaturedResultsSetTypeDef#

# FeaturedResultsSetTypeDef usage example

from mypy_boto3_kendra.type_defs import FeaturedResultsSetTypeDef

def get_value() -> FeaturedResultsSetTypeDef:
    return {
        "FeaturedResultsSetId": ...,
    }
# FeaturedResultsSetTypeDef definition

class FeaturedResultsSetTypeDef(TypedDict):
    FeaturedResultsSetId: NotRequired[str],
    FeaturedResultsSetName: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[FeaturedResultsSetStatusType],  # (1)
    QueryTexts: NotRequired[List[str]],
    FeaturedDocuments: NotRequired[List[FeaturedDocumentTypeDef]],  # (2)
    LastUpdatedTimestamp: NotRequired[int],
    CreationTimestamp: NotRequired[int],
  1. See FeaturedResultsSetStatusType
  2. See FeaturedDocumentTypeDef

UpdateFeaturedResultsSetRequestRequestTypeDef#

# UpdateFeaturedResultsSetRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import UpdateFeaturedResultsSetRequestRequestTypeDef

def get_value() -> UpdateFeaturedResultsSetRequestRequestTypeDef:
    return {
        "IndexId": ...,
        "FeaturedResultsSetId": ...,
    }
# UpdateFeaturedResultsSetRequestRequestTypeDef definition

class UpdateFeaturedResultsSetRequestRequestTypeDef(TypedDict):
    IndexId: str,
    FeaturedResultsSetId: str,
    FeaturedResultsSetName: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[FeaturedResultsSetStatusType],  # (1)
    QueryTexts: NotRequired[Sequence[str]],
    FeaturedDocuments: NotRequired[Sequence[FeaturedDocumentTypeDef]],  # (2)
  1. See FeaturedResultsSetStatusType
  2. See FeaturedDocumentTypeDef

UserContextTypeDef#

# UserContextTypeDef usage example

from mypy_boto3_kendra.type_defs import UserContextTypeDef

def get_value() -> UserContextTypeDef:
    return {
        "Token": ...,
    }
# UserContextTypeDef definition

class UserContextTypeDef(TypedDict):
    Token: NotRequired[str],
    UserId: NotRequired[str],
    Groups: NotRequired[Sequence[str]],
    DataSourceGroups: NotRequired[Sequence[DataSourceGroupTypeDef]],  # (1)
  1. See DataSourceGroupTypeDef

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListDataSourcesResponseTypeDef

def get_value() -> ListDataSourcesResponseTypeDef:
    return {
        "SummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDataSourcesResponseTypeDef definition

class ListDataSourcesResponseTypeDef(TypedDict):
    SummaryItems: List[DataSourceSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataSourceSummaryTypeDef
  2. See ResponseMetadataTypeDef

DataSourceSyncJobTypeDef#

# DataSourceSyncJobTypeDef usage example

from mypy_boto3_kendra.type_defs import DataSourceSyncJobTypeDef

def get_value() -> DataSourceSyncJobTypeDef:
    return {
        "ExecutionId": ...,
    }
# DataSourceSyncJobTypeDef 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)
  1. See DataSourceSyncJobStatusType
  2. See ErrorCodeType
  3. See DataSourceSyncJobMetricsTypeDef

ExperiencesSummaryTypeDef#

# ExperiencesSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import ExperiencesSummaryTypeDef

def get_value() -> ExperiencesSummaryTypeDef:
    return {
        "Name": ...,
    }
# ExperiencesSummaryTypeDef definition

class ExperiencesSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    Status: NotRequired[ExperienceStatusType],  # (1)
    Endpoints: NotRequired[List[ExperienceEndpointTypeDef]],  # (2)
  1. See ExperienceStatusType
  2. See ExperienceEndpointTypeDef

DescribeFeaturedResultsSetResponseTypeDef#

# DescribeFeaturedResultsSetResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribeFeaturedResultsSetResponseTypeDef

def get_value() -> DescribeFeaturedResultsSetResponseTypeDef:
    return {
        "FeaturedResultsSetId": ...,
        "FeaturedResultsSetName": ...,
        "Description": ...,
        "Status": ...,
        "QueryTexts": ...,
        "FeaturedDocumentsWithMetadata": ...,
        "FeaturedDocumentsMissing": ...,
        "LastUpdatedTimestamp": ...,
        "CreationTimestamp": ...,
        "ResponseMetadata": ...,
    }
# DescribeFeaturedResultsSetResponseTypeDef definition

class DescribeFeaturedResultsSetResponseTypeDef(TypedDict):
    FeaturedResultsSetId: str,
    FeaturedResultsSetName: str,
    Description: str,
    Status: FeaturedResultsSetStatusType,  # (1)
    QueryTexts: List[str],
    FeaturedDocumentsWithMetadata: List[FeaturedDocumentWithMetadataTypeDef],  # (2)
    FeaturedDocumentsMissing: List[FeaturedDocumentMissingTypeDef],  # (3)
    LastUpdatedTimestamp: int,
    CreationTimestamp: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FeaturedResultsSetStatusType
  2. See FeaturedDocumentWithMetadataTypeDef
  3. See FeaturedDocumentMissingTypeDef
  4. See ResponseMetadataTypeDef

DescribePrincipalMappingResponseTypeDef#

# DescribePrincipalMappingResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import DescribePrincipalMappingResponseTypeDef

def get_value() -> DescribePrincipalMappingResponseTypeDef:
    return {
        "IndexId": ...,
        "DataSourceId": ...,
        "GroupId": ...,
        "GroupOrderingIdSummaries": ...,
        "ResponseMetadata": ...,
    }
# DescribePrincipalMappingResponseTypeDef definition

class DescribePrincipalMappingResponseTypeDef(TypedDict):
    IndexId: str,
    DataSourceId: str,
    GroupId: str,
    GroupOrderingIdSummaries: List[GroupOrderingIdSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupOrderingIdSummaryTypeDef
  2. See ResponseMetadataTypeDef

DocumentAttributeConditionTypeDef#

# DocumentAttributeConditionTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentAttributeConditionTypeDef

def get_value() -> DocumentAttributeConditionTypeDef:
    return {
        "ConditionDocumentAttributeKey": ...,
        "Operator": ...,
    }
# DocumentAttributeConditionTypeDef definition

class DocumentAttributeConditionTypeDef(TypedDict):
    ConditionDocumentAttributeKey: str,
    Operator: ConditionOperatorType,  # (1)
    ConditionOnValue: NotRequired[DocumentAttributeValueTypeDef],  # (2)
  1. See ConditionOperatorType
  2. See DocumentAttributeValueTypeDef

DocumentAttributeTargetTypeDef#

# DocumentAttributeTargetTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentAttributeTargetTypeDef

def get_value() -> DocumentAttributeTargetTypeDef:
    return {
        "TargetDocumentAttributeKey": ...,
    }
# DocumentAttributeTargetTypeDef definition

class DocumentAttributeTargetTypeDef(TypedDict):
    TargetDocumentAttributeKey: NotRequired[str],
    TargetDocumentAttributeValueDeletion: NotRequired[bool],
    TargetDocumentAttributeValue: NotRequired[DocumentAttributeValueTypeDef],  # (1)
  1. See DocumentAttributeValueTypeDef

DocumentAttributeTypeDef#

# DocumentAttributeTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentAttributeTypeDef

def get_value() -> DocumentAttributeTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# DocumentAttributeTypeDef definition

class DocumentAttributeTypeDef(TypedDict):
    Key: str,
    Value: DocumentAttributeValueTypeDef,  # (1)
  1. See DocumentAttributeValueTypeDef

DocumentAttributeValueCountPairTypeDef#

# DocumentAttributeValueCountPairTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentAttributeValueCountPairTypeDef

def get_value() -> DocumentAttributeValueCountPairTypeDef:
    return {
        "DocumentAttributeValue": ...,
    }
# DocumentAttributeValueCountPairTypeDef definition

class DocumentAttributeValueCountPairTypeDef(TypedDict):
    DocumentAttributeValue: NotRequired[DocumentAttributeValueTypeDef],  # (1)
    Count: NotRequired[int],
    FacetResults: NotRequired[List[FacetResultTypeDef]],  # (2)
  1. See DocumentAttributeValueTypeDef
  2. See FacetResultTypeDef

DocumentRelevanceConfigurationTypeDef#

# DocumentRelevanceConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentRelevanceConfigurationTypeDef

def get_value() -> DocumentRelevanceConfigurationTypeDef:
    return {
        "Name": ...,
        "Relevance": ...,
    }
# DocumentRelevanceConfigurationTypeDef definition

class DocumentRelevanceConfigurationTypeDef(TypedDict):
    Name: str,
    Relevance: RelevanceTypeDef,  # (1)
  1. See RelevanceTypeDef

DocumentMetadataConfigurationTypeDef#

# DocumentMetadataConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import DocumentMetadataConfigurationTypeDef

def get_value() -> DocumentMetadataConfigurationTypeDef:
    return {
        "Name": ...,
        "Type": ...,
    }
# DocumentMetadataConfigurationTypeDef definition

class DocumentMetadataConfigurationTypeDef(TypedDict):
    Name: str,
    Type: DocumentAttributeValueTypeType,  # (1)
    Relevance: NotRequired[RelevanceTypeDef],  # (2)
    Search: NotRequired[SearchTypeDef],  # (3)
  1. See DocumentAttributeValueTypeType
  2. See RelevanceTypeDef
  3. See SearchTypeDef

S3DataSourceConfigurationTypeDef#

# S3DataSourceConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import S3DataSourceConfigurationTypeDef

def get_value() -> S3DataSourceConfigurationTypeDef:
    return {
        "BucketName": ...,
    }
# S3DataSourceConfigurationTypeDef definition

class S3DataSourceConfigurationTypeDef(TypedDict):
    BucketName: str,
    InclusionPrefixes: NotRequired[Sequence[str]],
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    DocumentsMetadataConfiguration: NotRequired[DocumentsMetadataConfigurationTypeDef],  # (1)
    AccessControlListConfiguration: NotRequired[AccessControlListConfigurationTypeDef],  # (2)
  1. See DocumentsMetadataConfigurationTypeDef
  2. See AccessControlListConfigurationTypeDef

ExperienceEntitiesSummaryTypeDef#

# ExperienceEntitiesSummaryTypeDef usage example

from mypy_boto3_kendra.type_defs import ExperienceEntitiesSummaryTypeDef

def get_value() -> ExperienceEntitiesSummaryTypeDef:
    return {
        "EntityId": ...,
    }
# ExperienceEntitiesSummaryTypeDef definition

class ExperienceEntitiesSummaryTypeDef(TypedDict):
    EntityId: NotRequired[str],
    EntityType: NotRequired[EntityTypeType],  # (1)
    DisplayData: NotRequired[EntityDisplayDataTypeDef],  # (2)
  1. See EntityTypeType
  2. See EntityDisplayDataTypeDef

ExperienceConfigurationTypeDef#

# ExperienceConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import ExperienceConfigurationTypeDef

def get_value() -> ExperienceConfigurationTypeDef:
    return {
        "ContentSourceConfiguration": ...,
    }
# ExperienceConfigurationTypeDef definition

class ExperienceConfigurationTypeDef(TypedDict):
    ContentSourceConfiguration: NotRequired[ContentSourceConfigurationTypeDef],  # (1)
    UserIdentityConfiguration: NotRequired[UserIdentityConfigurationTypeDef],  # (2)
  1. See ContentSourceConfigurationTypeDef
  2. See UserIdentityConfigurationTypeDef

ListFaqsResponseTypeDef#

# ListFaqsResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListFaqsResponseTypeDef

def get_value() -> ListFaqsResponseTypeDef:
    return {
        "NextToken": ...,
        "FaqSummaryItems": ...,
        "ResponseMetadata": ...,
    }
# ListFaqsResponseTypeDef definition

class ListFaqsResponseTypeDef(TypedDict):
    NextToken: str,
    FaqSummaryItems: List[FaqSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FaqSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListFeaturedResultsSetsResponseTypeDef#

# ListFeaturedResultsSetsResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListFeaturedResultsSetsResponseTypeDef

def get_value() -> ListFeaturedResultsSetsResponseTypeDef:
    return {
        "FeaturedResultsSetSummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListFeaturedResultsSetsResponseTypeDef definition

class ListFeaturedResultsSetsResponseTypeDef(TypedDict):
    FeaturedResultsSetSummaryItems: List[FeaturedResultsSetSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeaturedResultsSetSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetSnapshotsResponseTypeDef#

# GetSnapshotsResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import GetSnapshotsResponseTypeDef

def get_value() -> GetSnapshotsResponseTypeDef:
    return {
        "SnapShotTimeFilter": ...,
        "SnapshotsDataHeader": ...,
        "SnapshotsData": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# GetSnapshotsResponseTypeDef definition

class GetSnapshotsResponseTypeDef(TypedDict):
    SnapShotTimeFilter: TimeRangeTypeDef,  # (1)
    SnapshotsDataHeader: List[str],
    SnapshotsData: List[List[str]],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimeRangeTypeDef
  2. See ResponseMetadataTypeDef

ListDataSourceSyncJobsRequestRequestTypeDef#

# ListDataSourceSyncJobsRequestRequestTypeDef usage example

from mypy_boto3_kendra.type_defs import ListDataSourceSyncJobsRequestRequestTypeDef

def get_value() -> ListDataSourceSyncJobsRequestRequestTypeDef:
    return {
        "Id": ...,
        "IndexId": ...,
    }
# ListDataSourceSyncJobsRequestRequestTypeDef definition

class ListDataSourceSyncJobsRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StartTimeFilter: NotRequired[TimeRangeTypeDef],  # (1)
    StatusFilter: NotRequired[DataSourceSyncJobStatusType],  # (2)
  1. See TimeRangeTypeDef
  2. See DataSourceSyncJobStatusType

GroupMembersTypeDef#

# GroupMembersTypeDef usage example

from mypy_boto3_kendra.type_defs import GroupMembersTypeDef

def get_value() -> GroupMembersTypeDef:
    return {
        "MemberGroups": ...,
    }
# GroupMembersTypeDef definition

class GroupMembersTypeDef(TypedDict):
    MemberGroups: NotRequired[Sequence[MemberGroupTypeDef]],  # (1)
    MemberUsers: NotRequired[Sequence[MemberUserTypeDef]],  # (2)
    S3PathforGroupMembers: NotRequired[S3PathTypeDef],  # (3)
  1. See MemberGroupTypeDef
  2. See MemberUserTypeDef
  3. See S3PathTypeDef

ListGroupsOlderThanOrderingIdResponseTypeDef#

# ListGroupsOlderThanOrderingIdResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListGroupsOlderThanOrderingIdResponseTypeDef

def get_value() -> ListGroupsOlderThanOrderingIdResponseTypeDef:
    return {
        "GroupsSummaries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupsOlderThanOrderingIdResponseTypeDef definition

class ListGroupsOlderThanOrderingIdResponseTypeDef(TypedDict):
    GroupsSummaries: List[GroupSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

TextWithHighlightsTypeDef#

# TextWithHighlightsTypeDef usage example

from mypy_boto3_kendra.type_defs import TextWithHighlightsTypeDef

def get_value() -> TextWithHighlightsTypeDef:
    return {
        "Text": ...,
    }
# TextWithHighlightsTypeDef definition

class TextWithHighlightsTypeDef(TypedDict):
    Text: NotRequired[str],
    Highlights: NotRequired[List[HighlightTypeDef]],  # (1)
  1. See HighlightTypeDef

ListIndicesResponseTypeDef#

# ListIndicesResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListIndicesResponseTypeDef

def get_value() -> ListIndicesResponseTypeDef:
    return {
        "IndexConfigurationSummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListIndicesResponseTypeDef definition

class ListIndicesResponseTypeDef(TypedDict):
    IndexConfigurationSummaryItems: List[IndexConfigurationSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IndexConfigurationSummaryTypeDef
  2. See ResponseMetadataTypeDef

IndexStatisticsTypeDef#

# IndexStatisticsTypeDef usage example

from mypy_boto3_kendra.type_defs import IndexStatisticsTypeDef

def get_value() -> IndexStatisticsTypeDef:
    return {
        "FaqStatistics": ...,
        "TextDocumentStatistics": ...,
    }
# IndexStatisticsTypeDef definition

class IndexStatisticsTypeDef(TypedDict):
    FaqStatistics: FaqStatisticsTypeDef,  # (1)
    TextDocumentStatistics: TextDocumentStatisticsTypeDef,  # (2)
  1. See FaqStatisticsTypeDef
  2. See TextDocumentStatisticsTypeDef

UserTokenConfigurationTypeDef#

# UserTokenConfigurationTypeDef usage example

from mypy_boto3_kendra.type_defs import UserTokenConfigurationTypeDef

def get_value() -> UserTokenConfigurationTypeDef:
    return {
        "JwtTokenTypeConfiguration": ...,
    }
# UserTokenConfigurationTypeDef definition

class UserTokenConfigurationTypeDef(TypedDict):
    JwtTokenTypeConfiguration: NotRequired[JwtTokenTypeConfigurationTypeDef],  # (1)
    JsonTokenTypeConfiguration: NotRequired[JsonTokenTypeConfigurationTypeDef],  # (2)
  1. See JwtTokenTypeConfigurationTypeDef
  2. See JsonTokenTypeConfigurationTypeDef

ListEntityPersonasResponseTypeDef#

# ListEntityPersonasResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListEntityPersonasResponseTypeDef

def get_value() -> ListEntityPersonasResponseTypeDef:
    return {
        "SummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListEntityPersonasResponseTypeDef definition

class ListEntityPersonasResponseTypeDef(TypedDict):
    SummaryItems: List[PersonasSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PersonasSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListQuerySuggestionsBlockListsResponseTypeDef#

# ListQuerySuggestionsBlockListsResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListQuerySuggestionsBlockListsResponseTypeDef

def get_value() -> ListQuerySuggestionsBlockListsResponseTypeDef:
    return {
        "BlockListSummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListQuerySuggestionsBlockListsResponseTypeDef definition

class ListQuerySuggestionsBlockListsResponseTypeDef(TypedDict):
    BlockListSummaryItems: List[QuerySuggestionsBlockListSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuerySuggestionsBlockListSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListThesauriResponseTypeDef#

# ListThesauriResponseTypeDef usage example

from mypy_boto3_kendra.type_defs import ListThesauriResponseTypeDef

def get_value() -> ListThesauriResponseTypeDef:
    return {
        "NextToken": ...,
        "ThesaurusSummaryItems": ...,
        "ResponseMetadata": ...,
    }
# ListThesauriResponseTypeDef definition

class ListThesauriResponseTypeDef(TypedDict):
    NextToken: str,
    ThesaurusSummaryItems: List[ThesaurusSummaryTypeDef],  # (1)
    Resp