Skip to content

Type definitions#

Index > Kendra > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ContentSourceConfigurationUnionTypeDef#

# ContentSourceConfigurationUnionTypeDef definition

ContentSourceConfigurationUnionTypeDef = Union[
    ContentSourceConfigurationTypeDef,  # (1)
    ContentSourceConfigurationOutputTypeDef,  # (2)
]
  1. See ContentSourceConfigurationTypeDef
  2. See ContentSourceConfigurationOutputTypeDef

DataSourceVpcConfigurationUnionTypeDef#

# DataSourceVpcConfigurationUnionTypeDef definition

DataSourceVpcConfigurationUnionTypeDef = Union[
    DataSourceVpcConfigurationTypeDef,  # (1)
    DataSourceVpcConfigurationOutputTypeDef,  # (2)
]
  1. See DataSourceVpcConfigurationTypeDef
  2. See DataSourceVpcConfigurationOutputTypeDef

RelevanceUnionTypeDef#

# RelevanceUnionTypeDef definition

RelevanceUnionTypeDef = Union[
    RelevanceTypeDef,  # (1)
    RelevanceOutputTypeDef,  # (2)
]
  1. See RelevanceTypeDef
  2. See RelevanceOutputTypeDef

SeedUrlConfigurationUnionTypeDef#

# SeedUrlConfigurationUnionTypeDef definition

SeedUrlConfigurationUnionTypeDef = Union[
    SeedUrlConfigurationTypeDef,  # (1)
    SeedUrlConfigurationOutputTypeDef,  # (2)
]
  1. See SeedUrlConfigurationTypeDef
  2. See SeedUrlConfigurationOutputTypeDef

SiteMapsConfigurationUnionTypeDef#

# SiteMapsConfigurationUnionTypeDef definition

SiteMapsConfigurationUnionTypeDef = Union[
    SiteMapsConfigurationTypeDef,  # (1)
    SiteMapsConfigurationOutputTypeDef,  # (2)
]
  1. See SiteMapsConfigurationTypeDef
  2. See SiteMapsConfigurationOutputTypeDef

TemplateConfigurationUnionTypeDef#

# TemplateConfigurationUnionTypeDef definition

TemplateConfigurationUnionTypeDef = Union[
    TemplateConfigurationTypeDef,  # (1)
    TemplateConfigurationOutputTypeDef,  # (2)
]
  1. See TemplateConfigurationTypeDef
  2. See TemplateConfigurationOutputTypeDef

ColumnConfigurationUnionTypeDef#

# ColumnConfigurationUnionTypeDef definition

ColumnConfigurationUnionTypeDef = Union[
    ColumnConfigurationTypeDef,  # (1)
    ColumnConfigurationOutputTypeDef,  # (2)
]
  1. See ColumnConfigurationTypeDef
  2. See ColumnConfigurationOutputTypeDef

GoogleDriveConfigurationUnionTypeDef#

# GoogleDriveConfigurationUnionTypeDef definition

GoogleDriveConfigurationUnionTypeDef = Union[
    GoogleDriveConfigurationTypeDef,  # (1)
    GoogleDriveConfigurationOutputTypeDef,  # (2)
]
  1. See GoogleDriveConfigurationTypeDef
  2. See GoogleDriveConfigurationOutputTypeDef

SalesforceChatterFeedConfigurationUnionTypeDef#

# SalesforceChatterFeedConfigurationUnionTypeDef definition

SalesforceChatterFeedConfigurationUnionTypeDef = Union[
    SalesforceChatterFeedConfigurationTypeDef,  # (1)
    SalesforceChatterFeedConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceChatterFeedConfigurationTypeDef
  2. See SalesforceChatterFeedConfigurationOutputTypeDef

SalesforceCustomKnowledgeArticleTypeConfigurationUnionTypeDef#

# SalesforceCustomKnowledgeArticleTypeConfigurationUnionTypeDef definition

SalesforceCustomKnowledgeArticleTypeConfigurationUnionTypeDef = Union[
    SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef,  # (1)
    SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef
  2. See SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef

SalesforceStandardKnowledgeArticleTypeConfigurationUnionTypeDef#

# SalesforceStandardKnowledgeArticleTypeConfigurationUnionTypeDef definition

SalesforceStandardKnowledgeArticleTypeConfigurationUnionTypeDef = Union[
    SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef,  # (1)
    SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef
  2. See SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef

SalesforceStandardObjectAttachmentConfigurationUnionTypeDef#

# SalesforceStandardObjectAttachmentConfigurationUnionTypeDef definition

SalesforceStandardObjectAttachmentConfigurationUnionTypeDef = Union[
    SalesforceStandardObjectAttachmentConfigurationTypeDef,  # (1)
    SalesforceStandardObjectAttachmentConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceStandardObjectAttachmentConfigurationTypeDef
  2. See SalesforceStandardObjectAttachmentConfigurationOutputTypeDef

SalesforceStandardObjectConfigurationUnionTypeDef#

# SalesforceStandardObjectConfigurationUnionTypeDef definition

SalesforceStandardObjectConfigurationUnionTypeDef = Union[
    SalesforceStandardObjectConfigurationTypeDef,  # (1)
    SalesforceStandardObjectConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceStandardObjectConfigurationTypeDef
  2. See SalesforceStandardObjectConfigurationOutputTypeDef

ServiceNowKnowledgeArticleConfigurationUnionTypeDef#

# ServiceNowKnowledgeArticleConfigurationUnionTypeDef definition

ServiceNowKnowledgeArticleConfigurationUnionTypeDef = Union[
    ServiceNowKnowledgeArticleConfigurationTypeDef,  # (1)
    ServiceNowKnowledgeArticleConfigurationOutputTypeDef,  # (2)
]
  1. See ServiceNowKnowledgeArticleConfigurationTypeDef
  2. See ServiceNowKnowledgeArticleConfigurationOutputTypeDef

ServiceNowServiceCatalogConfigurationUnionTypeDef#

# ServiceNowServiceCatalogConfigurationUnionTypeDef definition

ServiceNowServiceCatalogConfigurationUnionTypeDef = Union[
    ServiceNowServiceCatalogConfigurationTypeDef,  # (1)
    ServiceNowServiceCatalogConfigurationOutputTypeDef,  # (2)
]
  1. See ServiceNowServiceCatalogConfigurationTypeDef
  2. See ServiceNowServiceCatalogConfigurationOutputTypeDef

WorkDocsConfigurationUnionTypeDef#

# WorkDocsConfigurationUnionTypeDef definition

WorkDocsConfigurationUnionTypeDef = Union[
    WorkDocsConfigurationTypeDef,  # (1)
    WorkDocsConfigurationOutputTypeDef,  # (2)
]
  1. See WorkDocsConfigurationTypeDef
  2. See WorkDocsConfigurationOutputTypeDef

OneDriveUsersUnionTypeDef#

# OneDriveUsersUnionTypeDef definition

OneDriveUsersUnionTypeDef = Union[
    OneDriveUsersTypeDef,  # (1)
    OneDriveUsersOutputTypeDef,  # (2)
]
  1. See OneDriveUsersTypeDef
  2. See OneDriveUsersOutputTypeDef

AuthenticationConfigurationUnionTypeDef#

# AuthenticationConfigurationUnionTypeDef definition

AuthenticationConfigurationUnionTypeDef = Union[
    AuthenticationConfigurationTypeDef,  # (1)
    AuthenticationConfigurationOutputTypeDef,  # (2)
]
  1. See AuthenticationConfigurationTypeDef
  2. See AuthenticationConfigurationOutputTypeDef

DocumentAttributeValueUnionTypeDef#

# DocumentAttributeValueUnionTypeDef definition

DocumentAttributeValueUnionTypeDef = Union[
    DocumentAttributeValueTypeDef,  # (1)
    DocumentAttributeValueOutputTypeDef,  # (2)
]
  1. See DocumentAttributeValueTypeDef
  2. See DocumentAttributeValueOutputTypeDef

ConfluenceAttachmentConfigurationUnionTypeDef#

# ConfluenceAttachmentConfigurationUnionTypeDef definition

ConfluenceAttachmentConfigurationUnionTypeDef = Union[
    ConfluenceAttachmentConfigurationTypeDef,  # (1)
    ConfluenceAttachmentConfigurationOutputTypeDef,  # (2)
]
  1. See ConfluenceAttachmentConfigurationTypeDef
  2. See ConfluenceAttachmentConfigurationOutputTypeDef

ConfluenceBlogConfigurationUnionTypeDef#

# ConfluenceBlogConfigurationUnionTypeDef definition

ConfluenceBlogConfigurationUnionTypeDef = Union[
    ConfluenceBlogConfigurationTypeDef,  # (1)
    ConfluenceBlogConfigurationOutputTypeDef,  # (2)
]
  1. See ConfluenceBlogConfigurationTypeDef
  2. See ConfluenceBlogConfigurationOutputTypeDef

ConfluencePageConfigurationUnionTypeDef#

# ConfluencePageConfigurationUnionTypeDef definition

ConfluencePageConfigurationUnionTypeDef = Union[
    ConfluencePageConfigurationTypeDef,  # (1)
    ConfluencePageConfigurationOutputTypeDef,  # (2)
]
  1. See ConfluencePageConfigurationTypeDef
  2. See ConfluencePageConfigurationOutputTypeDef

ConfluenceSpaceConfigurationUnionTypeDef#

# ConfluenceSpaceConfigurationUnionTypeDef definition

ConfluenceSpaceConfigurationUnionTypeDef = Union[
    ConfluenceSpaceConfigurationTypeDef,  # (1)
    ConfluenceSpaceConfigurationOutputTypeDef,  # (2)
]
  1. See ConfluenceSpaceConfigurationTypeDef
  2. See ConfluenceSpaceConfigurationOutputTypeDef

HierarchicalPrincipalUnionTypeDef#

# HierarchicalPrincipalUnionTypeDef definition

HierarchicalPrincipalUnionTypeDef = Union[
    HierarchicalPrincipalTypeDef,  # (1)
    HierarchicalPrincipalOutputTypeDef,  # (2)
]
  1. See HierarchicalPrincipalTypeDef
  2. See HierarchicalPrincipalOutputTypeDef

S3DataSourceConfigurationUnionTypeDef#

# S3DataSourceConfigurationUnionTypeDef definition

S3DataSourceConfigurationUnionTypeDef = Union[
    S3DataSourceConfigurationTypeDef,  # (1)
    S3DataSourceConfigurationOutputTypeDef,  # (2)
]
  1. See S3DataSourceConfigurationTypeDef
  2. See S3DataSourceConfigurationOutputTypeDef

AlfrescoConfigurationUnionTypeDef#

# AlfrescoConfigurationUnionTypeDef definition

AlfrescoConfigurationUnionTypeDef = Union[
    AlfrescoConfigurationTypeDef,  # (1)
    AlfrescoConfigurationOutputTypeDef,  # (2)
]
  1. See AlfrescoConfigurationTypeDef
  2. See AlfrescoConfigurationOutputTypeDef

BoxConfigurationUnionTypeDef#

# BoxConfigurationUnionTypeDef definition

BoxConfigurationUnionTypeDef = Union[
    BoxConfigurationTypeDef,  # (1)
    BoxConfigurationOutputTypeDef,  # (2)
]
  1. See BoxConfigurationTypeDef
  2. See BoxConfigurationOutputTypeDef

FsxConfigurationUnionTypeDef#

# FsxConfigurationUnionTypeDef definition

FsxConfigurationUnionTypeDef = Union[
    FsxConfigurationTypeDef,  # (1)
    FsxConfigurationOutputTypeDef,  # (2)
]
  1. See FsxConfigurationTypeDef
  2. See FsxConfigurationOutputTypeDef

GitHubConfigurationUnionTypeDef#

# GitHubConfigurationUnionTypeDef definition

GitHubConfigurationUnionTypeDef = Union[
    GitHubConfigurationTypeDef,  # (1)
    GitHubConfigurationOutputTypeDef,  # (2)
]
  1. See GitHubConfigurationTypeDef
  2. See GitHubConfigurationOutputTypeDef

JiraConfigurationUnionTypeDef#

# JiraConfigurationUnionTypeDef definition

JiraConfigurationUnionTypeDef = Union[
    JiraConfigurationTypeDef,  # (1)
    JiraConfigurationOutputTypeDef,  # (2)
]
  1. See JiraConfigurationTypeDef
  2. See JiraConfigurationOutputTypeDef

QuipConfigurationUnionTypeDef#

# QuipConfigurationUnionTypeDef definition

QuipConfigurationUnionTypeDef = Union[
    QuipConfigurationTypeDef,  # (1)
    QuipConfigurationOutputTypeDef,  # (2)
]
  1. See QuipConfigurationTypeDef
  2. See QuipConfigurationOutputTypeDef

SharePointConfigurationUnionTypeDef#

# SharePointConfigurationUnionTypeDef definition

SharePointConfigurationUnionTypeDef = Union[
    SharePointConfigurationTypeDef,  # (1)
    SharePointConfigurationOutputTypeDef,  # (2)
]
  1. See SharePointConfigurationTypeDef
  2. See SharePointConfigurationOutputTypeDef

SlackConfigurationUnionTypeDef#

# SlackConfigurationUnionTypeDef definition

SlackConfigurationUnionTypeDef = Union[
    SlackConfigurationTypeDef,  # (1)
    SlackConfigurationOutputTypeDef,  # (2)
]
  1. See SlackConfigurationTypeDef
  2. See SlackConfigurationOutputTypeDef

DocumentMetadataConfigurationUnionTypeDef#

# DocumentMetadataConfigurationUnionTypeDef definition

DocumentMetadataConfigurationUnionTypeDef = Union[
    DocumentMetadataConfigurationTypeDef,  # (1)
    DocumentMetadataConfigurationOutputTypeDef,  # (2)
]
  1. See DocumentMetadataConfigurationTypeDef
  2. See DocumentMetadataConfigurationOutputTypeDef

UrlsUnionTypeDef#

# UrlsUnionTypeDef definition

UrlsUnionTypeDef = Union[
    UrlsTypeDef,  # (1)
    UrlsOutputTypeDef,  # (2)
]
  1. See UrlsTypeDef
  2. See UrlsOutputTypeDef

DatabaseConfigurationUnionTypeDef#

# DatabaseConfigurationUnionTypeDef definition

DatabaseConfigurationUnionTypeDef = Union[
    DatabaseConfigurationTypeDef,  # (1)
    DatabaseConfigurationOutputTypeDef,  # (2)
]
  1. See DatabaseConfigurationTypeDef
  2. See DatabaseConfigurationOutputTypeDef

SalesforceKnowledgeArticleConfigurationUnionTypeDef#

# SalesforceKnowledgeArticleConfigurationUnionTypeDef definition

SalesforceKnowledgeArticleConfigurationUnionTypeDef = Union[
    SalesforceKnowledgeArticleConfigurationTypeDef,  # (1)
    SalesforceKnowledgeArticleConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceKnowledgeArticleConfigurationTypeDef
  2. See SalesforceKnowledgeArticleConfigurationOutputTypeDef

ServiceNowConfigurationUnionTypeDef#

# ServiceNowConfigurationUnionTypeDef definition

ServiceNowConfigurationUnionTypeDef = Union[
    ServiceNowConfigurationTypeDef,  # (1)
    ServiceNowConfigurationOutputTypeDef,  # (2)
]
  1. See ServiceNowConfigurationTypeDef
  2. See ServiceNowConfigurationOutputTypeDef

OneDriveConfigurationUnionTypeDef#

# OneDriveConfigurationUnionTypeDef definition

OneDriveConfigurationUnionTypeDef = Union[
    OneDriveConfigurationTypeDef,  # (1)
    OneDriveConfigurationOutputTypeDef,  # (2)
]
  1. See OneDriveConfigurationTypeDef
  2. See OneDriveConfigurationOutputTypeDef

DocumentAttributeConditionUnionTypeDef#

# DocumentAttributeConditionUnionTypeDef definition

DocumentAttributeConditionUnionTypeDef = Union[
    DocumentAttributeConditionTypeDef,  # (1)
    DocumentAttributeConditionOutputTypeDef,  # (2)
]
  1. See DocumentAttributeConditionTypeDef
  2. See DocumentAttributeConditionOutputTypeDef

DocumentAttributeTargetUnionTypeDef#

# DocumentAttributeTargetUnionTypeDef definition

DocumentAttributeTargetUnionTypeDef = Union[
    DocumentAttributeTargetTypeDef,  # (1)
    DocumentAttributeTargetOutputTypeDef,  # (2)
]
  1. See DocumentAttributeTargetTypeDef
  2. See DocumentAttributeTargetOutputTypeDef

DocumentAttributeUnionTypeDef#

# DocumentAttributeUnionTypeDef definition

DocumentAttributeUnionTypeDef = Union[
    DocumentAttributeTypeDef,  # (1)
    DocumentAttributeOutputTypeDef,  # (2)
]
  1. See DocumentAttributeTypeDef
  2. See DocumentAttributeOutputTypeDef

ConfluenceConfigurationUnionTypeDef#

# ConfluenceConfigurationUnionTypeDef definition

ConfluenceConfigurationUnionTypeDef = Union[
    ConfluenceConfigurationTypeDef,  # (1)
    ConfluenceConfigurationOutputTypeDef,  # (2)
]
  1. See ConfluenceConfigurationTypeDef
  2. See ConfluenceConfigurationOutputTypeDef

WebCrawlerConfigurationUnionTypeDef#

# WebCrawlerConfigurationUnionTypeDef definition

WebCrawlerConfigurationUnionTypeDef = Union[
    WebCrawlerConfigurationTypeDef,  # (1)
    WebCrawlerConfigurationOutputTypeDef,  # (2)
]
  1. See WebCrawlerConfigurationTypeDef
  2. See WebCrawlerConfigurationOutputTypeDef

SalesforceConfigurationUnionTypeDef#

# SalesforceConfigurationUnionTypeDef definition

SalesforceConfigurationUnionTypeDef = Union[
    SalesforceConfigurationTypeDef,  # (1)
    SalesforceConfigurationOutputTypeDef,  # (2)
]
  1. See SalesforceConfigurationTypeDef
  2. See SalesforceConfigurationOutputTypeDef

HookConfigurationUnionTypeDef#

# HookConfigurationUnionTypeDef definition

HookConfigurationUnionTypeDef = Union[
    HookConfigurationTypeDef,  # (1)
    HookConfigurationOutputTypeDef,  # (2)
]
  1. See HookConfigurationTypeDef
  2. See HookConfigurationOutputTypeDef

InlineCustomDocumentEnrichmentConfigurationUnionTypeDef#

# InlineCustomDocumentEnrichmentConfigurationUnionTypeDef definition

InlineCustomDocumentEnrichmentConfigurationUnionTypeDef = Union[
    InlineCustomDocumentEnrichmentConfigurationTypeDef,  # (1)
    InlineCustomDocumentEnrichmentConfigurationOutputTypeDef,  # (2)
]
  1. See InlineCustomDocumentEnrichmentConfigurationTypeDef
  2. See InlineCustomDocumentEnrichmentConfigurationOutputTypeDef

AccessControlConfigurationSummaryTypeDef#

# AccessControlConfigurationSummaryTypeDef definition

class AccessControlConfigurationSummaryTypeDef(TypedDict):
    Id: str,

AccessControlListConfigurationTypeDef#

# AccessControlListConfigurationTypeDef definition

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

AclConfigurationTypeDef#

# AclConfigurationTypeDef definition

class AclConfigurationTypeDef(TypedDict):
    AllowedGroupsColumnName: str,

DataSourceToIndexFieldMappingTypeDef#

# DataSourceToIndexFieldMappingTypeDef definition

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

DataSourceVpcConfigurationOutputTypeDef#

# DataSourceVpcConfigurationOutputTypeDef definition

class DataSourceVpcConfigurationOutputTypeDef(TypedDict):
    SubnetIds: list[str],
    SecurityGroupIds: list[str],

S3PathTypeDef#

# S3PathTypeDef definition

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

EntityConfigurationTypeDef#

# EntityConfigurationTypeDef definition

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

FailedEntityTypeDef#

# FailedEntityTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

EntityPersonaConfigurationTypeDef#

# EntityPersonaConfigurationTypeDef definition

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

SuggestableConfigTypeDef#

# SuggestableConfigTypeDef definition

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

BasicAuthenticationConfigurationTypeDef#

# BasicAuthenticationConfigurationTypeDef definition

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

DataSourceSyncJobMetricTargetTypeDef#

# DataSourceSyncJobMetricTargetTypeDef definition

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

BatchDeleteDocumentResponseFailedDocumentTypeDef#

# BatchDeleteDocumentResponseFailedDocumentTypeDef definition

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

BatchDeleteFeaturedResultsSetErrorTypeDef#

# BatchDeleteFeaturedResultsSetErrorTypeDef definition

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

BatchDeleteFeaturedResultsSetRequestRequestTypeDef#

# BatchDeleteFeaturedResultsSetRequestRequestTypeDef definition

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

BatchGetDocumentStatusResponseErrorTypeDef#

# BatchGetDocumentStatusResponseErrorTypeDef definition

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

StatusTypeDef#

# StatusTypeDef definition

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

BatchPutDocumentResponseFailedDocumentTypeDef#

# BatchPutDocumentResponseFailedDocumentTypeDef definition

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

CapacityUnitsConfigurationTypeDef#

# CapacityUnitsConfigurationTypeDef definition

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

ClearQuerySuggestionsRequestRequestTypeDef#

# ClearQuerySuggestionsRequestRequestTypeDef definition

class ClearQuerySuggestionsRequestRequestTypeDef(TypedDict):
    IndexId: str,

ExpandConfigurationTypeDef#

# ExpandConfigurationTypeDef definition

class ExpandConfigurationTypeDef(TypedDict):
    MaxResultItemsToExpand: NotRequired[int],
    MaxExpandedResultsPerItem: NotRequired[int],

SortingConfigurationTypeDef#

# SortingConfigurationTypeDef definition

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

ConfluenceAttachmentToIndexFieldMappingTypeDef#

# ConfluenceAttachmentToIndexFieldMappingTypeDef definition

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

ConfluenceBlogToIndexFieldMappingTypeDef#

# ConfluenceBlogToIndexFieldMappingTypeDef definition

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

ProxyConfigurationTypeDef#

# ProxyConfigurationTypeDef definition

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

ConfluencePageToIndexFieldMappingTypeDef#

# ConfluencePageToIndexFieldMappingTypeDef definition

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

ConfluenceSpaceToIndexFieldMappingTypeDef#

# ConfluenceSpaceToIndexFieldMappingTypeDef definition

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

ConnectionConfigurationTypeDef#

# ConnectionConfigurationTypeDef definition

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

ContentSourceConfigurationOutputTypeDef#

# ContentSourceConfigurationOutputTypeDef definition

class ContentSourceConfigurationOutputTypeDef(TypedDict):
    DataSourceIds: NotRequired[list[str]],
    FaqIds: NotRequired[list[str]],
    DirectPutContent: NotRequired[bool],

ContentSourceConfigurationTypeDef#

# ContentSourceConfigurationTypeDef definition

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

CorrectionTypeDef#

# CorrectionTypeDef definition

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

PrincipalTypeDef#

# PrincipalTypeDef definition

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

DataSourceVpcConfigurationTypeDef#

# DataSourceVpcConfigurationTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

FeaturedDocumentTypeDef#

# FeaturedDocumentTypeDef definition

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

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef definition

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

UserGroupResolutionConfigurationTypeDef#

# UserGroupResolutionConfigurationTypeDef definition

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

TemplateConfigurationOutputTypeDef#

# TemplateConfigurationOutputTypeDef definition

class TemplateConfigurationOutputTypeDef(TypedDict):
    Template: NotRequired[dict[str, Any]],

DataSourceGroupTypeDef#

# DataSourceGroupTypeDef definition

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

DataSourceSummaryTypeDef#

# 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 definition

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

SqlConfigurationTypeDef#

# SqlConfigurationTypeDef definition

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

DeleteAccessControlConfigurationRequestRequestTypeDef#

# DeleteAccessControlConfigurationRequestRequestTypeDef definition

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

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef definition

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

DeleteExperienceRequestRequestTypeDef#

# DeleteExperienceRequestRequestTypeDef definition

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

DeleteFaqRequestRequestTypeDef#

# DeleteFaqRequestRequestTypeDef definition

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

DeleteIndexRequestRequestTypeDef#

# DeleteIndexRequestRequestTypeDef definition

class DeleteIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DeletePrincipalMappingRequestRequestTypeDef#

# DeletePrincipalMappingRequestRequestTypeDef definition

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

DeleteQuerySuggestionsBlockListRequestRequestTypeDef#

# DeleteQuerySuggestionsBlockListRequestRequestTypeDef definition

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

DeleteThesaurusRequestRequestTypeDef#

# DeleteThesaurusRequestRequestTypeDef definition

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

DescribeAccessControlConfigurationRequestRequestTypeDef#

# DescribeAccessControlConfigurationRequestRequestTypeDef definition

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

DescribeDataSourceRequestRequestTypeDef#

# DescribeDataSourceRequestRequestTypeDef definition

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

DescribeExperienceRequestRequestTypeDef#

# DescribeExperienceRequestRequestTypeDef definition

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

ExperienceEndpointTypeDef#

# ExperienceEndpointTypeDef definition

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

DescribeFaqRequestRequestTypeDef#

# DescribeFaqRequestRequestTypeDef definition

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

DescribeFeaturedResultsSetRequestRequestTypeDef#

# DescribeFeaturedResultsSetRequestRequestTypeDef definition

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

FeaturedDocumentMissingTypeDef#

# FeaturedDocumentMissingTypeDef definition

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

FeaturedDocumentWithMetadataTypeDef#

# FeaturedDocumentWithMetadataTypeDef definition

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

DescribeIndexRequestRequestTypeDef#

# DescribeIndexRequestRequestTypeDef definition

class DescribeIndexRequestRequestTypeDef(TypedDict):
    Id: str,

DescribePrincipalMappingRequestRequestTypeDef#

# DescribePrincipalMappingRequestRequestTypeDef definition

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

GroupOrderingIdSummaryTypeDef#

# 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 definition

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

DescribeQuerySuggestionsConfigRequestRequestTypeDef#

# DescribeQuerySuggestionsConfigRequestRequestTypeDef definition

class DescribeQuerySuggestionsConfigRequestRequestTypeDef(TypedDict):
    IndexId: str,

DescribeThesaurusRequestRequestTypeDef#

# DescribeThesaurusRequestRequestTypeDef definition

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

DisassociatePersonasFromEntitiesRequestRequestTypeDef#

# DisassociatePersonasFromEntitiesRequestRequestTypeDef definition

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

DocumentAttributeValueOutputTypeDef#

# DocumentAttributeValueOutputTypeDef definition

class DocumentAttributeValueOutputTypeDef(TypedDict):
    StringValue: NotRequired[str],
    StringListValue: NotRequired[list[str]],
    LongValue: NotRequired[int],
    DateValue: NotRequired[datetime],

RelevanceOutputTypeDef#

# RelevanceOutputTypeDef definition

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

SearchTypeDef#

# SearchTypeDef definition

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

DocumentsMetadataConfigurationTypeDef#

# DocumentsMetadataConfigurationTypeDef definition

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

EntityDisplayDataTypeDef#

# EntityDisplayDataTypeDef definition

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

UserIdentityConfigurationTypeDef#

# UserIdentityConfigurationTypeDef definition

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

FacetTypeDef#

# FacetTypeDef definition

class FacetTypeDef(TypedDict):
    DocumentAttributeKey: NotRequired[str],
    Facets: NotRequired[Sequence[Mapping[str, Any]]],
    MaxResults: NotRequired[int],

FaqStatisticsTypeDef#

# FaqStatisticsTypeDef definition

class FaqStatisticsTypeDef(TypedDict):
    IndexedQuestionAnswersCount: int,

FaqSummaryTypeDef#

# 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 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 definition

class GetSnapshotsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Interval: IntervalType,  # (1)
    MetricType: MetricTypeType,  # (2)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See IntervalType
  2. See MetricTypeType

TimeRangeOutputTypeDef#

# TimeRangeOutputTypeDef definition

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

GitHubDocumentCrawlPropertiesTypeDef#

# 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 definition

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

MemberGroupTypeDef#

# MemberGroupTypeDef definition

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

MemberUserTypeDef#

# MemberUserTypeDef definition

class MemberUserTypeDef(TypedDict):
    UserId: str,

GroupSummaryTypeDef#

# GroupSummaryTypeDef definition

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

HighlightTypeDef#

# HighlightTypeDef definition

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

IndexConfigurationSummaryTypeDef#

# 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 definition

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

JsonTokenTypeConfigurationTypeDef#

# JsonTokenTypeConfigurationTypeDef definition

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

JwtTokenTypeConfigurationTypeDef#

# 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 definition

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

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef definition

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

ListEntityPersonasRequestRequestTypeDef#

# ListEntityPersonasRequestRequestTypeDef definition

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

PersonasSummaryTypeDef#

# PersonasSummaryTypeDef definition

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

ListExperienceEntitiesRequestRequestTypeDef#

# ListExperienceEntitiesRequestRequestTypeDef definition

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

ListExperiencesRequestRequestTypeDef#

# ListExperiencesRequestRequestTypeDef definition

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

ListFaqsRequestRequestTypeDef#

# ListFaqsRequestRequestTypeDef definition

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

ListFeaturedResultsSetsRequestRequestTypeDef#

# ListFeaturedResultsSetsRequestRequestTypeDef definition

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

ListGroupsOlderThanOrderingIdRequestRequestTypeDef#

# ListGroupsOlderThanOrderingIdRequestRequestTypeDef definition

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

ListIndicesRequestRequestTypeDef#

# ListIndicesRequestRequestTypeDef definition

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

ListQuerySuggestionsBlockListsRequestRequestTypeDef#

# ListQuerySuggestionsBlockListsRequestRequestTypeDef definition

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

QuerySuggestionsBlockListSummaryTypeDef#

# 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 definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

ListThesauriRequestRequestTypeDef#

# ListThesauriRequestRequestTypeDef definition

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

ThesaurusSummaryTypeDef#

# ThesaurusSummaryTypeDef definition

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

SpellCorrectionConfigurationTypeDef#

# SpellCorrectionConfigurationTypeDef definition

class SpellCorrectionConfigurationTypeDef(TypedDict):
    IncludeQuerySpellCheckSuggestions: bool,

ScoreAttributesTypeDef#

# ScoreAttributesTypeDef definition

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

WarningTypeDef#

# WarningTypeDef definition

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

RelevanceFeedbackTypeDef#

# RelevanceFeedbackTypeDef definition

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

RelevanceTypeDef#

# RelevanceTypeDef definition

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

SeedUrlConfigurationOutputTypeDef#

# SeedUrlConfigurationOutputTypeDef definition

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

SeedUrlConfigurationTypeDef#

# SeedUrlConfigurationTypeDef definition

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

SiteMapsConfigurationOutputTypeDef#

# SiteMapsConfigurationOutputTypeDef definition

class SiteMapsConfigurationOutputTypeDef(TypedDict):
    SiteMaps: list[str],

SiteMapsConfigurationTypeDef#

# SiteMapsConfigurationTypeDef definition

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

StartDataSourceSyncJobRequestRequestTypeDef#

# StartDataSourceSyncJobRequestRequestTypeDef definition

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

StopDataSourceSyncJobRequestRequestTypeDef#

# StopDataSourceSyncJobRequestRequestTypeDef definition

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

SuggestionHighlightTypeDef#

# SuggestionHighlightTypeDef definition

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

TableCellTypeDef#

# TableCellTypeDef definition

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

TemplateConfigurationTypeDef#

# TemplateConfigurationTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

ColumnConfigurationOutputTypeDef#

# ColumnConfigurationOutputTypeDef definition

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

ColumnConfigurationTypeDef#

# ColumnConfigurationTypeDef definition

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

GoogleDriveConfigurationOutputTypeDef#

# GoogleDriveConfigurationOutputTypeDef definition

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

GoogleDriveConfigurationTypeDef#

# 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

SalesforceChatterFeedConfigurationOutputTypeDef#

# SalesforceChatterFeedConfigurationOutputTypeDef definition

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

SalesforceChatterFeedConfigurationTypeDef#

# 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

SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef#

# SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef definition

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

SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef#

# SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef definition

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

SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef#

# SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef definition

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

SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef#

# SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef definition

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

SalesforceStandardObjectAttachmentConfigurationOutputTypeDef#

# SalesforceStandardObjectAttachmentConfigurationOutputTypeDef definition

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

SalesforceStandardObjectAttachmentConfigurationTypeDef#

# SalesforceStandardObjectAttachmentConfigurationTypeDef definition

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

SalesforceStandardObjectConfigurationOutputTypeDef#

# SalesforceStandardObjectConfigurationOutputTypeDef definition

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

SalesforceStandardObjectConfigurationTypeDef#

# SalesforceStandardObjectConfigurationTypeDef definition

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

ServiceNowKnowledgeArticleConfigurationOutputTypeDef#

# ServiceNowKnowledgeArticleConfigurationOutputTypeDef definition

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

ServiceNowKnowledgeArticleConfigurationTypeDef#

# 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

ServiceNowServiceCatalogConfigurationOutputTypeDef#

# ServiceNowServiceCatalogConfigurationOutputTypeDef definition

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

ServiceNowServiceCatalogConfigurationTypeDef#

# 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

WorkDocsConfigurationOutputTypeDef#

# WorkDocsConfigurationOutputTypeDef definition

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

WorkDocsConfigurationTypeDef#

# 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

BoxConfigurationOutputTypeDef#

# BoxConfigurationOutputTypeDef definition

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

FsxConfigurationOutputTypeDef#

# FsxConfigurationOutputTypeDef definition

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

JiraConfigurationOutputTypeDef#

# JiraConfigurationOutputTypeDef definition

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

QuipConfigurationOutputTypeDef#

# QuipConfigurationOutputTypeDef definition

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

SlackConfigurationOutputTypeDef#

# SlackConfigurationOutputTypeDef definition

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

AlfrescoConfigurationOutputTypeDef#

# AlfrescoConfigurationOutputTypeDef definition

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

OnPremiseConfigurationTypeDef#

# OnPremiseConfigurationTypeDef definition

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

OneDriveUsersOutputTypeDef#

# OneDriveUsersOutputTypeDef definition

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

OneDriveUsersTypeDef#

# OneDriveUsersTypeDef definition

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

UpdateQuerySuggestionsBlockListRequestRequestTypeDef#

# 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 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 definition

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

DisassociateEntitiesFromExperienceRequestRequestTypeDef#

# DisassociateEntitiesFromExperienceRequestRequestTypeDef definition

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

AssociateEntitiesToExperienceResponseTypeDef#

# AssociateEntitiesToExperienceResponseTypeDef definition

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

AssociatePersonasToEntitiesResponseTypeDef#

# AssociatePersonasToEntitiesResponseTypeDef definition

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

CreateAccessControlConfigurationResponseTypeDef#

# CreateAccessControlConfigurationResponseTypeDef definition

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

CreateDataSourceResponseTypeDef#

# CreateDataSourceResponseTypeDef definition

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

CreateExperienceResponseTypeDef#

# CreateExperienceResponseTypeDef definition

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

CreateFaqResponseTypeDef#

# CreateFaqResponseTypeDef definition

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

CreateIndexResponseTypeDef#

# CreateIndexResponseTypeDef definition

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

CreateQuerySuggestionsBlockListResponseTypeDef#

# CreateQuerySuggestionsBlockListResponseTypeDef definition

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

CreateThesaurusResponseTypeDef#

# CreateThesaurusResponseTypeDef definition

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

DescribeFaqResponseTypeDef#

# 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 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 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

DisassociateEntitiesFromExperienceResponseTypeDef#

# DisassociateEntitiesFromExperienceResponseTypeDef definition

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

DisassociatePersonasFromEntitiesResponseTypeDef#

# DisassociatePersonasFromEntitiesResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListAccessControlConfigurationsResponseTypeDef#

# ListAccessControlConfigurationsResponseTypeDef definition

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

StartDataSourceSyncJobResponseTypeDef#

# StartDataSourceSyncJobResponseTypeDef definition

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

AssociatePersonasToEntitiesRequestRequestTypeDef#

# AssociatePersonasToEntitiesRequestRequestTypeDef definition

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

AttributeSuggestionsDescribeConfigTypeDef#

# AttributeSuggestionsDescribeConfigTypeDef definition

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

AttributeSuggestionsUpdateConfigTypeDef#

# AttributeSuggestionsUpdateConfigTypeDef definition

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

AuthenticationConfigurationOutputTypeDef#

# AuthenticationConfigurationOutputTypeDef definition

class AuthenticationConfigurationOutputTypeDef(TypedDict):
    BasicAuthentication: NotRequired[list[BasicAuthenticationConfigurationTypeDef]],  # (1)
  1. See BasicAuthenticationConfigurationTypeDef

AuthenticationConfigurationTypeDef#

# AuthenticationConfigurationTypeDef definition

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

BatchDeleteDocumentRequestRequestTypeDef#

# BatchDeleteDocumentRequestRequestTypeDef definition

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

BatchDeleteDocumentResponseTypeDef#

# BatchDeleteDocumentResponseTypeDef definition

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

BatchDeleteFeaturedResultsSetResponseTypeDef#

# BatchDeleteFeaturedResultsSetResponseTypeDef definition

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

BatchGetDocumentStatusResponseTypeDef#

# 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 definition

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

ClickFeedbackTypeDef#

# ClickFeedbackTypeDef definition

class ClickFeedbackTypeDef(TypedDict):
    ResultId: str,
    ClickTime: TimestampTypeDef,

DocumentAttributeValueTypeDef#

# DocumentAttributeValueTypeDef definition

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

TimeRangeTypeDef#

# TimeRangeTypeDef definition

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

CollapseConfigurationTypeDef#

# CollapseConfigurationTypeDef definition

class CollapseConfigurationTypeDef(TypedDict):
    DocumentAttributeKey: str,
    SortingConfigurations: NotRequired[Sequence[SortingConfigurationTypeDef]],  # (1)
    MissingAttributeKeyStrategy: NotRequired[MissingAttributeKeyStrategyType],  # (2)
    Expand: NotRequired[bool],
    ExpandConfiguration: NotRequired[ExpandConfigurationTypeDef],  # (3)
  1. See SortingConfigurationTypeDef
  2. See MissingAttributeKeyStrategyType
  3. See ExpandConfigurationTypeDef

ConfluenceAttachmentConfigurationOutputTypeDef#

# ConfluenceAttachmentConfigurationOutputTypeDef definition

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

ConfluenceAttachmentConfigurationTypeDef#

# ConfluenceAttachmentConfigurationTypeDef definition

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

ConfluenceBlogConfigurationOutputTypeDef#

# ConfluenceBlogConfigurationOutputTypeDef definition

class ConfluenceBlogConfigurationOutputTypeDef(TypedDict):
    BlogFieldMappings: NotRequired[list[ConfluenceBlogToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluenceBlogToIndexFieldMappingTypeDef

ConfluenceBlogConfigurationTypeDef#

# ConfluenceBlogConfigurationTypeDef definition

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

SharePointConfigurationOutputTypeDef#

# SharePointConfigurationOutputTypeDef definition

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

ConfluencePageConfigurationOutputTypeDef#

# ConfluencePageConfigurationOutputTypeDef definition

class ConfluencePageConfigurationOutputTypeDef(TypedDict):
    PageFieldMappings: NotRequired[list[ConfluencePageToIndexFieldMappingTypeDef]],  # (1)
  1. See ConfluencePageToIndexFieldMappingTypeDef

ConfluencePageConfigurationTypeDef#

# ConfluencePageConfigurationTypeDef definition

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

ConfluenceSpaceConfigurationOutputTypeDef#

# ConfluenceSpaceConfigurationOutputTypeDef definition

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

ConfluenceSpaceConfigurationTypeDef#

# 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 definition

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

HierarchicalPrincipalOutputTypeDef#

# HierarchicalPrincipalOutputTypeDef definition

class HierarchicalPrincipalOutputTypeDef(TypedDict):
    PrincipalList: list[PrincipalTypeDef],  # (1)
  1. See PrincipalTypeDef

HierarchicalPrincipalTypeDef#

# HierarchicalPrincipalTypeDef definition

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

CreateFaqRequestRequestTypeDef#

# 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 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 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 definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

CreateFeaturedResultsSetRequestRequestTypeDef#

# 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 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 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 definition

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

ListDataSourcesResponseTypeDef#

# ListDataSourcesResponseTypeDef definition

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

DataSourceSyncJobTypeDef#

# 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 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 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 definition

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

DocumentAttributeConditionOutputTypeDef#

# DocumentAttributeConditionOutputTypeDef definition

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

DocumentAttributeOutputTypeDef#

# DocumentAttributeOutputTypeDef definition

class DocumentAttributeOutputTypeDef(TypedDict):
    Key: str,
    Value: DocumentAttributeValueOutputTypeDef,  # (1)
  1. See DocumentAttributeValueOutputTypeDef

DocumentAttributeTargetOutputTypeDef#

# DocumentAttributeTargetOutputTypeDef definition

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

DocumentAttributeValueCountPairTypeDef#

# DocumentAttributeValueCountPairTypeDef definition

class DocumentAttributeValueCountPairTypeDef(TypedDict):
    DocumentAttributeValue: NotRequired[DocumentAttributeValueOutputTypeDef],  # (1)
    Count: NotRequired[int],
    FacetResults: NotRequired[list[dict[str, Any]]],
  1. See DocumentAttributeValueOutputTypeDef

DocumentMetadataConfigurationOutputTypeDef#

# DocumentMetadataConfigurationOutputTypeDef definition

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

S3DataSourceConfigurationOutputTypeDef#

# S3DataSourceConfigurationOutputTypeDef definition

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

S3DataSourceConfigurationTypeDef#

# 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 definition

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

ExperienceConfigurationOutputTypeDef#

# ExperienceConfigurationOutputTypeDef definition

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

ListFaqsResponseTypeDef#

# ListFaqsResponseTypeDef definition

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

ListFeaturedResultsSetsResponseTypeDef#

# ListFeaturedResultsSetsResponseTypeDef definition

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

GetSnapshotsResponseTypeDef#

# GetSnapshotsResponseTypeDef definition

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

GroupMembersTypeDef#

# 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 definition

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

TextWithHighlightsTypeDef#

# TextWithHighlightsTypeDef definition

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

ListIndicesResponseTypeDef#

# ListIndicesResponseTypeDef definition

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

IndexStatisticsTypeDef#

# IndexStatisticsTypeDef definition

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

UserTokenConfigurationTypeDef#

# UserTokenConfigurationTypeDef definition

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

ListEntityPersonasResponseTypeDef#

# ListEntityPersonasResponseTypeDef definition

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

ListQuerySuggestionsBlockListsResponseTypeDef#

# ListQuerySuggestionsBlockListsResponseTypeDef definition

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

ListThesauriResponseTypeDef#

# ListThesauriResponseTypeDef definition

class ListThesauriResponseTypeDef(TypedDict):
    ThesaurusSummaryItems: list[ThesaurusSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ThesaurusSummaryTypeDef
  2. See ResponseMetadataTypeDef

UrlsOutputTypeDef#

# UrlsOutputTypeDef definition

class UrlsOutputTypeDef(TypedDict):
    SeedUrlConfiguration: NotRequired[SeedUrlConfigurationOutputTypeDef],  # (1)
    SiteMapsConfiguration: NotRequired[SiteMapsConfigurationOutputTypeDef],  # (2)
  1. See SeedUrlConfigurationOutputTypeDef
  2. See SiteMapsConfigurationOutputTypeDef

SuggestionTextWithHighlightsTypeDef#

# SuggestionTextWithHighlightsTypeDef definition

class SuggestionTextWithHighlightsTypeDef(TypedDict):
    Text: NotRequired[str],
    Highlights: NotRequired[list[SuggestionHighlightTypeDef]],  # (1)
  1. See SuggestionHighlightTypeDef

TableRowTypeDef#

# TableRowTypeDef definition

class TableRowTypeDef(TypedDict):
    Cells: NotRequired[list[TableCellTypeDef]],  # (1)
  1. See TableCellTypeDef

DatabaseConfigurationOutputTypeDef#

# DatabaseConfigurationOutputTypeDef definition

class DatabaseConfigurationOutputTypeDef(TypedDict):
    DatabaseEngineType: DatabaseEngineTypeType,  # (1)
    ConnectionConfiguration: ConnectionConfigurationTypeDef,  # (2)
    ColumnConfiguration: ColumnConfigurationOutputTypeDef,  # (4)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef],  # (3)
    AclConfiguration: NotRequired[AclConfigurationTypeDef],  # (5)
    SqlConfiguration: NotRequired[SqlConfigurationTypeDef],  # (6)
  1. See DatabaseEngineTypeType
  2. See ConnectionConfigurationTypeDef
  3. See DataSourceVpcConfigurationOutputTypeDef
  4. See ColumnConfigurationOutputTypeDef
  5. See AclConfigurationTypeDef
  6. See SqlConfigurationTypeDef

SalesforceKnowledgeArticleConfigurationOutputTypeDef#

# SalesforceKnowledgeArticleConfigurationOutputTypeDef definition

class SalesforceKnowledgeArticleConfigurationOutputTypeDef(TypedDict):
    IncludedStates: list[SalesforceKnowledgeArticleStateType],  # (1)
    StandardKnowledgeArticleTypeConfiguration: NotRequired[SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef],  # (2)
    CustomKnowledgeArticleTypeConfigurations: NotRequired[list[SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef]],  # (3)
  1. See SalesforceKnowledgeArticleStateType
  2. See SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef
  3. See SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef

ServiceNowConfigurationOutputTypeDef#

# ServiceNowConfigurationOutputTypeDef definition

class ServiceNowConfigurationOutputTypeDef(TypedDict):
    HostUrl: str,
    SecretArn: str,
    ServiceNowBuildVersion: ServiceNowBuildVersionTypeType,  # (1)
    KnowledgeArticleConfiguration: NotRequired[ServiceNowKnowledgeArticleConfigurationOutputTypeDef],  # (2)
    ServiceCatalogConfiguration: NotRequired[ServiceNowServiceCatalogConfigurationOutputTypeDef],  # (3)
    AuthenticationType: NotRequired[ServiceNowAuthenticationTypeType],  # (4)
  1. See ServiceNowBuildVersionTypeType
  2. See ServiceNowKnowledgeArticleConfigurationOutputTypeDef
  3. See ServiceNowServiceCatalogConfigurationOutputTypeDef
  4. See ServiceNowAuthenticationTypeType

GitHubConfigurationOutputTypeDef#

# GitHubConfigurationOutputTypeDef definition

class GitHubConfigurationOutputTypeDef(TypedDict):
    SecretArn: str,
    SaaSConfiguration: NotRequired[SaaSConfigurationTypeDef],  # (1)
    OnPremiseConfiguration: NotRequired[OnPremiseConfigurationTypeDef],  # (2)
    Type: NotRequired[TypeType],  # (3)
    UseChangeLog: NotRequired[bool],
    GitHubDocumentCrawlProperties: NotRequired[GitHubDocumentCrawlPropertiesTypeDef],  # (4)
    RepositoryFilter: NotRequired[list[str]],
    InclusionFolderNamePatterns: NotRequired[list[str]],
    InclusionFileTypePatterns: NotRequired[list[str]],
    InclusionFileNamePatterns: NotRequired[list[str]],
    ExclusionFolderNamePatterns: NotRequired[list[str]],
    ExclusionFileTypePatterns: NotRequired[list[str]],
    ExclusionFileNamePatterns: NotRequired[list[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef],  # (5)
    GitHubRepositoryConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubCommitConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueDocumentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueCommentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueAttachmentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestCommentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestDocumentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (6)
  1. See SaaSConfigurationTypeDef
  2. See OnPremiseConfigurationTypeDef
  3. See TypeType
  4. See GitHubDocumentCrawlPropertiesTypeDef
  5. See DataSourceVpcConfigurationOutputTypeDef
  6. See DataSourceToIndexFieldMappingTypeDef
  7. See DataSourceToIndexFieldMappingTypeDef
  8. See DataSourceToIndexFieldMappingTypeDef
  9. See DataSourceToIndexFieldMappingTypeDef
  10. See DataSourceToIndexFieldMappingTypeDef
  11. See DataSourceToIndexFieldMappingTypeDef
  12. See DataSourceToIndexFieldMappingTypeDef
  13. See DataSourceToIndexFieldMappingTypeDef

OneDriveConfigurationOutputTypeDef#

# OneDriveConfigurationOutputTypeDef definition

class OneDriveConfigurationOutputTypeDef(TypedDict):
    TenantDomain: str,
    SecretArn: str,
    OneDriveUsers: OneDriveUsersOutputTypeDef,  # (1)
    InclusionPatterns: NotRequired[list[str]],
    ExclusionPatterns: NotRequired[list[str]],
    FieldMappings: NotRequired[list[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    DisableLocalGroups: NotRequired[bool],
  1. See OneDriveUsersOutputTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef

DescribeQuerySuggestionsConfigResponseTypeDef#

# DescribeQuerySuggestionsConfigResponseTypeDef definition

class DescribeQuerySuggestionsConfigResponseTypeDef(TypedDict):
    Mode: ModeType,  # (1)
    Status: QuerySuggestionsStatusType,  # (2)
    QueryLogLookBackWindowInDays: int,
    IncludeQueriesWithoutUserInformation: bool,
    MinimumNumberOfQueryingUsers: int,
    MinimumQueryCount: int,
    LastSuggestionsBuildTime: datetime,
    LastClearTime: datetime,
    TotalSuggestionsCount: int,
    AttributeSuggestionsConfig: AttributeSuggestionsDescribeConfigTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ModeType
  2. See QuerySuggestionsStatusType
  3. See AttributeSuggestionsDescribeConfigTypeDef
  4. See ResponseMetadataTypeDef

UpdateQuerySuggestionsConfigRequestRequestTypeDef#

# UpdateQuerySuggestionsConfigRequestRequestTypeDef definition

class UpdateQuerySuggestionsConfigRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Mode: NotRequired[ModeType],  # (1)
    QueryLogLookBackWindowInDays: NotRequired[int],
    IncludeQueriesWithoutUserInformation: NotRequired[bool],
    MinimumNumberOfQueryingUsers: NotRequired[int],
    MinimumQueryCount: NotRequired[int],
    AttributeSuggestionsConfig: NotRequired[AttributeSuggestionsUpdateConfigTypeDef],  # (2)
  1. See ModeType
  2. See AttributeSuggestionsUpdateConfigTypeDef

SubmitFeedbackRequestRequestTypeDef#

# SubmitFeedbackRequestRequestTypeDef definition

class SubmitFeedbackRequestRequestTypeDef(TypedDict):
    IndexId: str,
    QueryId: str,
    ClickFeedbackItems: NotRequired[Sequence[ClickFeedbackTypeDef]],  # (1)
    RelevanceFeedbackItems: NotRequired[Sequence[RelevanceFeedbackTypeDef]],  # (2)
  1. See ClickFeedbackTypeDef
  2. See RelevanceFeedbackTypeDef

ListDataSourceSyncJobsRequestRequestTypeDef#

# 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

ConfluenceConfigurationOutputTypeDef#

# ConfluenceConfigurationOutputTypeDef definition

class ConfluenceConfigurationOutputTypeDef(TypedDict):
    ServerUrl: str,
    SecretArn: str,
    Version: ConfluenceVersionType,  # (1)
    SpaceConfiguration: NotRequired[ConfluenceSpaceConfigurationOutputTypeDef],  # (2)
    PageConfiguration: NotRequired[ConfluencePageConfigurationOutputTypeDef],  # (3)
    BlogConfiguration: NotRequired[ConfluenceBlogConfigurationOutputTypeDef],  # (4)
    AttachmentConfiguration: NotRequired[ConfluenceAttachmentConfigurationOutputTypeDef],  # (5)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationOutputTypeDef],  # (6)
    InclusionPatterns: NotRequired[list[str]],
    ExclusionPatterns: NotRequired[list[str]],
    ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef],  # (7)
    AuthenticationType: NotRequired[ConfluenceAuthenticationTypeType],  # (8)
  1. See ConfluenceVersionType
  2. See ConfluenceSpaceConfigurationOutputTypeDef
  3. See ConfluencePageConfigurationOutputTypeDef
  4. See ConfluenceBlogConfigurationOutputTypeDef
  5. See ConfluenceAttachmentConfigurationOutputTypeDef
  6. See DataSourceVpcConfigurationOutputTypeDef
  7. See ProxyConfigurationTypeDef
  8. See ConfluenceAuthenticationTypeType

ExperienceConfigurationTypeDef#

# ExperienceConfigurationTypeDef definition

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

DescribeAccessControlConfigurationResponseTypeDef#

# DescribeAccessControlConfigurationResponseTypeDef definition

class DescribeAccessControlConfigurationResponseTypeDef(TypedDict):
    Name: str,
    Description: str,
    ErrorMessage: str,
    AccessControlList: list[PrincipalTypeDef],  # (1)
    HierarchicalAccessControlList: list[HierarchicalPrincipalOutputTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PrincipalTypeDef
  2. See HierarchicalPrincipalOutputTypeDef
  3. See ResponseMetadataTypeDef

UpdateAccessControlConfigurationRequestRequestTypeDef#

# UpdateAccessControlConfigurationRequestRequestTypeDef definition

class UpdateAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Id: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    AccessControlList: NotRequired[Sequence[PrincipalTypeDef]],  # (1)
    HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalTypeDef]],  # (2)
  1. See PrincipalTypeDef
  2. See HierarchicalPrincipalTypeDef

AlfrescoConfigurationTypeDef#

# 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[DataSourceVpcConfigurationUnionTypeDef],  # (6)
  1. See S3PathTypeDef
  2. See AlfrescoEntityType
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceToIndexFieldMappingTypeDef
  6. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef

BoxConfigurationTypeDef#

# 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[DataSourceVpcConfigurationUnionTypeDef],  # (5)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef

FsxConfigurationTypeDef#

# FsxConfigurationTypeDef definition

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

GitHubConfigurationTypeDef#

# GitHubConfigurationTypeDef definition

class GitHubConfigurationTypeDef(TypedDict):
    SecretArn: str,
    SaaSConfiguration: NotRequired[SaaSConfigurationTypeDef],  # (1)
    OnPremiseConfiguration: NotRequired[OnPremiseConfigurationTypeDef],  # (2)
    Type: NotRequired[TypeType],  # (3)
    UseChangeLog: NotRequired[bool],
    GitHubDocumentCrawlProperties: NotRequired[GitHubDocumentCrawlPropertiesTypeDef],  # (4)
    RepositoryFilter: NotRequired[Sequence[str]],
    InclusionFolderNamePatterns: NotRequired[Sequence[str]],
    InclusionFileTypePatterns: NotRequired[Sequence[str]],
    InclusionFileNamePatterns: NotRequired[Sequence[str]],
    ExclusionFolderNamePatterns: NotRequired[Sequence[str]],
    ExclusionFileTypePatterns: NotRequired[Sequence[str]],
    ExclusionFileNamePatterns: NotRequired[Sequence[str]],
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef],  # (5)
    GitHubRepositoryConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubCommitConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueDocumentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueCommentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubIssueAttachmentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestCommentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestDocumentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
    GitHubPullRequestDocumentAttachmentConfigurationFieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (6)
  1. See SaaSConfigurationTypeDef
  2. See OnPremiseConfigurationTypeDef
  3. See TypeType
  4. See GitHubDocumentCrawlPropertiesTypeDef
  5. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
  6. See DataSourceToIndexFieldMappingTypeDef
  7. See DataSourceToIndexFieldMappingTypeDef
  8. See DataSourceToIndexFieldMappingTypeDef
  9. See DataSourceToIndexFieldMappingTypeDef
  10. See DataSourceToIndexFieldMappingTypeDef
  11. See DataSourceToIndexFieldMappingTypeDef
  12. See DataSourceToIndexFieldMappingTypeDef
  13. See DataSourceToIndexFieldMappingTypeDef

JiraConfigurationTypeDef#

# 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[DataSourceVpcConfigurationUnionTypeDef],  # (7)
  1. See IssueSubEntityType
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceToIndexFieldMappingTypeDef
  5. See DataSourceToIndexFieldMappingTypeDef
  6. See DataSourceToIndexFieldMappingTypeDef
  7. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef

QuipConfigurationTypeDef#

# 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[DataSourceVpcConfigurationUnionTypeDef],  # (4)
  1. See DataSourceToIndexFieldMappingTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef

SharePointConfigurationTypeDef#

# 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[DataSourceVpcConfigurationUnionTypeDef],  # (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 DataSourceVpcConfigurationOutputTypeDef
  3. See DataSourceToIndexFieldMappingTypeDef
  4. See S3PathTypeDef
  5. See SharePointOnlineAuthenticationTypeType
  6. See ProxyConfigurationTypeDef

SlackConfigurationTypeDef#

# SlackConfigurationTypeDef definition

class SlackConfigurationTypeDef(TypedDict):
    TeamId: str,
    SecretArn: str,
    SlackEntityList: Sequence[SlackEntityType],  # (2)
    SinceCrawlDate: str,
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef],  # (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 DataSourceVpcConfigurationOutputTypeDef
  2. See SlackEntityType
  3. See DataSourceToIndexFieldMappingTypeDef

CreateFeaturedResultsSetResponseTypeDef#

# CreateFeaturedResultsSetResponseTypeDef definition

class CreateFeaturedResultsSetResponseTypeDef(TypedDict):
    FeaturedResultsSet: FeaturedResultsSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeaturedResultsSetTypeDef
  2. See ResponseMetadataTypeDef

UpdateFeaturedResultsSetResponseTypeDef#

# UpdateFeaturedResultsSetResponseTypeDef definition

class UpdateFeaturedResultsSetResponseTypeDef(TypedDict):
    FeaturedResultsSet: FeaturedResultsSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeaturedResultsSetTypeDef
  2. See ResponseMetadataTypeDef

ListDataSourceSyncJobsResponseTypeDef#

# ListDataSourceSyncJobsResponseTypeDef definition

class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
    History: list[DataSourceSyncJobTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DataSourceSyncJobTypeDef
  2. See ResponseMetadataTypeDef

ListExperiencesResponseTypeDef#

# ListExperiencesResponseTypeDef definition

class ListExperiencesResponseTypeDef(TypedDict):
    SummaryItems: list[ExperiencesSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ExperiencesSummaryTypeDef
  2. See ResponseMetadataTypeDef

HookConfigurationOutputTypeDef#

# HookConfigurationOutputTypeDef definition

class HookConfigurationOutputTypeDef(TypedDict):
    LambdaArn: str,
    S3Bucket: str,
    InvocationCondition: NotRequired[DocumentAttributeConditionOutputTypeDef],  # (1)
  1. See DocumentAttributeConditionOutputTypeDef

RetrieveResultItemTypeDef#

# RetrieveResultItemTypeDef definition

class RetrieveResultItemTypeDef(TypedDict):
    Id: NotRequired[str],
    DocumentId: NotRequired[str],
    DocumentTitle: NotRequired[str],
    Content: NotRequired[str],
    DocumentURI: NotRequired[str],
    DocumentAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (1)
    ScoreAttributes: NotRequired[ScoreAttributesTypeDef],  # (2)
  1. See DocumentAttributeOutputTypeDef
  2. See ScoreAttributesTypeDef

SourceDocumentTypeDef#

# SourceDocumentTypeDef definition

class SourceDocumentTypeDef(TypedDict):
    DocumentId: NotRequired[str],
    SuggestionAttributes: NotRequired[list[str]],
    AdditionalAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (1)
  1. See DocumentAttributeOutputTypeDef

InlineCustomDocumentEnrichmentConfigurationOutputTypeDef#

# InlineCustomDocumentEnrichmentConfigurationOutputTypeDef definition

class InlineCustomDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
    Condition: NotRequired[DocumentAttributeConditionOutputTypeDef],  # (1)
    Target: NotRequired[DocumentAttributeTargetOutputTypeDef],  # (2)
    DocumentContentDeletion: NotRequired[bool],
  1. See DocumentAttributeConditionOutputTypeDef
  2. See DocumentAttributeTargetOutputTypeDef

FacetResultTypeDef#

# FacetResultTypeDef definition

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

ListExperienceEntitiesResponseTypeDef#

# ListExperienceEntitiesResponseTypeDef definition

class ListExperienceEntitiesResponseTypeDef(TypedDict):
    SummaryItems: list[ExperienceEntitiesSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ExperienceEntitiesSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeExperienceResponseTypeDef#

# DescribeExperienceResponseTypeDef definition

class DescribeExperienceResponseTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Name: str,
    Endpoints: list[ExperienceEndpointTypeDef],  # (1)
    Configuration: ExperienceConfigurationOutputTypeDef,  # (2)
    CreatedAt: datetime,
    UpdatedAt: datetime,
    Description: str,
    Status: ExperienceStatusType,  # (3)
    RoleArn: str,
    ErrorMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExperienceEndpointTypeDef
  2. See ExperienceConfigurationOutputTypeDef
  3. See ExperienceStatusType
  4. See ResponseMetadataTypeDef

PutPrincipalMappingRequestRequestTypeDef#

# PutPrincipalMappingRequestRequestTypeDef definition

class PutPrincipalMappingRequestRequestTypeDef(TypedDict):
    IndexId: str,
    GroupId: str,
    GroupMembers: GroupMembersTypeDef,  # (1)
    DataSourceId: NotRequired[str],
    OrderingId: NotRequired[int],
    RoleArn: NotRequired[str],
  1. See GroupMembersTypeDef

AdditionalResultAttributeValueTypeDef#

# AdditionalResultAttributeValueTypeDef definition

class AdditionalResultAttributeValueTypeDef(TypedDict):
    TextWithHighlightsValue: NotRequired[TextWithHighlightsTypeDef],  # (1)
  1. See TextWithHighlightsTypeDef

ExpandedResultItemTypeDef#

# ExpandedResultItemTypeDef definition

class ExpandedResultItemTypeDef(TypedDict):
    Id: NotRequired[str],
    DocumentId: NotRequired[str],
    DocumentTitle: NotRequired[TextWithHighlightsTypeDef],  # (1)
    DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef],  # (1)
    DocumentURI: NotRequired[str],
    DocumentAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (3)
  1. See TextWithHighlightsTypeDef
  2. See TextWithHighlightsTypeDef
  3. See DocumentAttributeOutputTypeDef

CreateIndexRequestRequestTypeDef#

# CreateIndexRequestRequestTypeDef definition

class CreateIndexRequestRequestTypeDef(TypedDict):
    Name: str,
    RoleArn: str,
    Edition: NotRequired[IndexEditionType],  # (1)
    ServerSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (2)
    Description: NotRequired[str],
    ClientToken: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
    UserTokenConfigurations: NotRequired[Sequence[UserTokenConfigurationTypeDef]],  # (4)
    UserContextPolicy: NotRequired[UserContextPolicyType],  # (5)
    UserGroupResolutionConfiguration: NotRequired[UserGroupResolutionConfigurationTypeDef],  # (6)
  1. See IndexEditionType
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See TagTypeDef
  4. See UserTokenConfigurationTypeDef
  5. See UserContextPolicyType
  6. See UserGroupResolutionConfigurationTypeDef

DescribeIndexResponseTypeDef#

# DescribeIndexResponseTypeDef definition

class DescribeIndexResponseTypeDef(TypedDict):
    Name: str,
    Id: str,
    Edition: IndexEditionType,  # (1)
    RoleArn: str,
    ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef,  # (2)
    Status: IndexStatusType,  # (3)
    Description: str,
    CreatedAt: datetime,
    UpdatedAt: datetime,
    DocumentMetadataConfigurations: list[DocumentMetadataConfigurationOutputTypeDef],  # (4)
    IndexStatistics: IndexStatisticsTypeDef,  # (5)
    ErrorMessage: str,
    CapacityUnits: CapacityUnitsConfigurationTypeDef,  # (6)
    UserTokenConfigurations: list[UserTokenConfigurationTypeDef],  # (7)
    UserContextPolicy: UserContextPolicyType,  # (8)
    UserGroupResolutionConfiguration: UserGroupResolutionConfigurationTypeDef,  # (9)
    ResponseMetadata: ResponseMetadataTypeDef,  # (10)
  1. See IndexEditionType
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See IndexStatusType
  4. See DocumentMetadataConfigurationOutputTypeDef
  5. See IndexStatisticsTypeDef
  6. See CapacityUnitsConfigurationTypeDef
  7. See UserTokenConfigurationTypeDef
  8. See UserContextPolicyType
  9. See UserGroupResolutionConfigurationTypeDef
  10. See ResponseMetadataTypeDef

DocumentMetadataConfigurationTypeDef#

# DocumentMetadataConfigurationTypeDef definition

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

DocumentRelevanceConfigurationTypeDef#

# DocumentRelevanceConfigurationTypeDef definition

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

WebCrawlerConfigurationOutputTypeDef#

# WebCrawlerConfigurationOutputTypeDef definition

class WebCrawlerConfigurationOutputTypeDef(TypedDict):
    Urls: UrlsOutputTypeDef,  # (1)
    CrawlDepth: NotRequired[int],
    MaxLinksPerPage: NotRequired[int],
    MaxContentSizePerPageInMegaBytes: NotRequired[float],
    MaxUrlsPerMinuteCrawlRate: NotRequired[int],
    UrlInclusionPatterns: NotRequired[list[str]],
    UrlExclusionPatterns: NotRequired[list[str]],
    ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef],  # (2)
    AuthenticationConfiguration: NotRequired[AuthenticationConfigurationOutputTypeDef],  # (3)
  1. See UrlsOutputTypeDef
  2. See ProxyConfigurationTypeDef
  3. See AuthenticationConfigurationOutputTypeDef

UrlsTypeDef#

# UrlsTypeDef definition

class UrlsTypeDef(TypedDict):
    SeedUrlConfiguration: NotRequired[SeedUrlConfigurationUnionTypeDef],  # (1)
    SiteMapsConfiguration: NotRequired[SiteMapsConfigurationUnionTypeDef],  # (2)
  1. See SeedUrlConfigurationTypeDef SeedUrlConfigurationOutputTypeDef
  2. See SiteMapsConfigurationTypeDef SiteMapsConfigurationOutputTypeDef

SuggestionValueTypeDef#

# SuggestionValueTypeDef definition

class SuggestionValueTypeDef(TypedDict):
    Text: NotRequired[SuggestionTextWithHighlightsTypeDef],  # (1)
  1. See SuggestionTextWithHighlightsTypeDef

TableExcerptTypeDef#

# TableExcerptTypeDef definition

class TableExcerptTypeDef(TypedDict):
    Rows: NotRequired[list[TableRowTypeDef]],  # (1)
    TotalNumberOfRows: NotRequired[int],
  1. See TableRowTypeDef

DatabaseConfigurationTypeDef#

# DatabaseConfigurationTypeDef definition

class DatabaseConfigurationTypeDef(TypedDict):
    DatabaseEngineType: DatabaseEngineTypeType,  # (1)
    ConnectionConfiguration: ConnectionConfigurationTypeDef,  # (2)
    ColumnConfiguration: ColumnConfigurationUnionTypeDef,  # (4)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef],  # (3)
    AclConfiguration: NotRequired[AclConfigurationTypeDef],  # (5)
    SqlConfiguration: NotRequired[SqlConfigurationTypeDef],  # (6)
  1. See DatabaseEngineTypeType
  2. See ConnectionConfigurationTypeDef
  3. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
  4. See ColumnConfigurationTypeDef ColumnConfigurationOutputTypeDef
  5. See AclConfigurationTypeDef
  6. See SqlConfigurationTypeDef

SalesforceConfigurationOutputTypeDef#

# SalesforceConfigurationOutputTypeDef definition

class SalesforceConfigurationOutputTypeDef(TypedDict):
    ServerUrl: str,
    SecretArn: str,
    StandardObjectConfigurations: NotRequired[list[SalesforceStandardObjectConfigurationOutputTypeDef]],  # (1)
    KnowledgeArticleConfiguration: NotRequired[SalesforceKnowledgeArticleConfigurationOutputTypeDef],  # (2)
    ChatterFeedConfiguration: NotRequired[SalesforceChatterFeedConfigurationOutputTypeDef],  # (3)
    CrawlAttachments: NotRequired[bool],
    StandardObjectAttachmentConfiguration: NotRequired[SalesforceStandardObjectAttachmentConfigurationOutputTypeDef],  # (4)
    IncludeAttachmentFilePatterns: NotRequired[list[str]],
    ExcludeAttachmentFilePatterns: NotRequired[list[str]],
  1. See SalesforceStandardObjectConfigurationOutputTypeDef
  2. See SalesforceKnowledgeArticleConfigurationOutputTypeDef
  3. See SalesforceChatterFeedConfigurationOutputTypeDef
  4. See SalesforceStandardObjectAttachmentConfigurationOutputTypeDef

SalesforceKnowledgeArticleConfigurationTypeDef#

# SalesforceKnowledgeArticleConfigurationTypeDef definition

class SalesforceKnowledgeArticleConfigurationTypeDef(TypedDict):
    IncludedStates: Sequence[SalesforceKnowledgeArticleStateType],  # (1)
    StandardKnowledgeArticleTypeConfiguration: NotRequired[SalesforceStandardKnowledgeArticleTypeConfigurationUnionTypeDef],  # (2)
    CustomKnowledgeArticleTypeConfigurations: NotRequired[Sequence[SalesforceCustomKnowledgeArticleTypeConfigurationUnionTypeDef]],  # (3)
  1. See SalesforceKnowledgeArticleStateType
  2. See SalesforceStandardKnowledgeArticleTypeConfigurationTypeDef SalesforceStandardKnowledgeArticleTypeConfigurationOutputTypeDef
  3. See SalesforceCustomKnowledgeArticleTypeConfigurationTypeDef SalesforceCustomKnowledgeArticleTypeConfigurationOutputTypeDef

ServiceNowConfigurationTypeDef#

# ServiceNowConfigurationTypeDef definition

class ServiceNowConfigurationTypeDef(TypedDict):
    HostUrl: str,
    SecretArn: str,
    ServiceNowBuildVersion: ServiceNowBuildVersionTypeType,  # (1)
    KnowledgeArticleConfiguration: NotRequired[ServiceNowKnowledgeArticleConfigurationUnionTypeDef],  # (2)
    ServiceCatalogConfiguration: NotRequired[ServiceNowServiceCatalogConfigurationUnionTypeDef],  # (3)
    AuthenticationType: NotRequired[ServiceNowAuthenticationTypeType],  # (4)
  1. See ServiceNowBuildVersionTypeType
  2. See ServiceNowKnowledgeArticleConfigurationTypeDef ServiceNowKnowledgeArticleConfigurationOutputTypeDef
  3. See ServiceNowServiceCatalogConfigurationTypeDef ServiceNowServiceCatalogConfigurationOutputTypeDef
  4. See ServiceNowAuthenticationTypeType

OneDriveConfigurationTypeDef#

# OneDriveConfigurationTypeDef definition

class OneDriveConfigurationTypeDef(TypedDict):
    TenantDomain: str,
    SecretArn: str,
    OneDriveUsers: OneDriveUsersUnionTypeDef,  # (1)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    FieldMappings: NotRequired[Sequence[DataSourceToIndexFieldMappingTypeDef]],  # (2)
    DisableLocalGroups: NotRequired[bool],
  1. See OneDriveUsersTypeDef OneDriveUsersOutputTypeDef
  2. See DataSourceToIndexFieldMappingTypeDef

DocumentAttributeConditionTypeDef#

# DocumentAttributeConditionTypeDef definition

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

DocumentAttributeTargetTypeDef#

# DocumentAttributeTargetTypeDef definition

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

DocumentAttributeTypeDef#

# DocumentAttributeTypeDef definition

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

ConfluenceConfigurationTypeDef#

# ConfluenceConfigurationTypeDef definition

class ConfluenceConfigurationTypeDef(TypedDict):
    ServerUrl: str,
    SecretArn: str,
    Version: ConfluenceVersionType,  # (1)
    SpaceConfiguration: NotRequired[ConfluenceSpaceConfigurationUnionTypeDef],  # (2)
    PageConfiguration: NotRequired[ConfluencePageConfigurationUnionTypeDef],  # (3)
    BlogConfiguration: NotRequired[ConfluenceBlogConfigurationUnionTypeDef],  # (4)
    AttachmentConfiguration: NotRequired[ConfluenceAttachmentConfigurationUnionTypeDef],  # (5)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef],  # (6)
    InclusionPatterns: NotRequired[Sequence[str]],
    ExclusionPatterns: NotRequired[Sequence[str]],
    ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef],  # (7)
    AuthenticationType: NotRequired[ConfluenceAuthenticationTypeType],  # (8)
  1. See ConfluenceVersionType
  2. See ConfluenceSpaceConfigurationTypeDef ConfluenceSpaceConfigurationOutputTypeDef
  3. See ConfluencePageConfigurationTypeDef ConfluencePageConfigurationOutputTypeDef
  4. See ConfluenceBlogConfigurationTypeDef ConfluenceBlogConfigurationOutputTypeDef
  5. See ConfluenceAttachmentConfigurationTypeDef ConfluenceAttachmentConfigurationOutputTypeDef
  6. See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
  7. See ProxyConfigurationTypeDef
  8. See ConfluenceAuthenticationTypeType

CreateExperienceRequestRequestTypeDef#

# CreateExperienceRequestRequestTypeDef definition

class CreateExperienceRequestRequestTypeDef(TypedDict):
    Name: str,
    IndexId: str,
    RoleArn: NotRequired[str],
    Configuration: NotRequired[ExperienceConfigurationTypeDef],  # (1)
    Description: NotRequired[str],
    ClientToken: NotRequired[str],
  1. See ExperienceConfigurationTypeDef

UpdateExperienceRequestRequestTypeDef#

# UpdateExperienceRequestRequestTypeDef definition

class UpdateExperienceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Name: NotRequired[str],
    RoleArn: NotRequired[str],
    Configuration: NotRequired[ExperienceConfigurationTypeDef],  # (1)
    Description: NotRequired[str],
  1. See ExperienceConfigurationTypeDef

CreateAccessControlConfigurationRequestRequestTypeDef#

# CreateAccessControlConfigurationRequestRequestTypeDef definition

class CreateAccessControlConfigurationRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Name: str,
    Description: NotRequired[str],
    AccessControlList: NotRequired[Sequence[PrincipalTypeDef]],  # (1)
    HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalUnionTypeDef]],  # (2)
    ClientToken: NotRequired[str],
  1. See PrincipalTypeDef
  2. See HierarchicalPrincipalTypeDef HierarchicalPrincipalOutputTypeDef

RetrieveResultTypeDef#

# RetrieveResultTypeDef definition

class RetrieveResultTypeDef(TypedDict):
    QueryId: str,
    ResultItems: list[RetrieveResultItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RetrieveResultItemTypeDef
  2. See ResponseMetadataTypeDef

CustomDocumentEnrichmentConfigurationOutputTypeDef#

# CustomDocumentEnrichmentConfigurationOutputTypeDef definition

class CustomDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
    InlineConfigurations: NotRequired[list[InlineCustomDocumentEnrichmentConfigurationOutputTypeDef]],  # (1)
    PreExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)
    PostExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef],  # (2)
    RoleArn: NotRequired[str],
  1. See InlineCustomDocumentEnrichmentConfigurationOutputTypeDef
  2. See HookConfigurationOutputTypeDef
  3. See HookConfigurationOutputTypeDef

AdditionalResultAttributeTypeDef#

# AdditionalResultAttributeTypeDef definition

class AdditionalResultAttributeTypeDef(TypedDict):
    Key: str,
    ValueType: AdditionalResultAttributeValueTypeType,  # (1)
    Value: AdditionalResultAttributeValueTypeDef,  # (2)
  1. See AdditionalResultAttributeValueTypeType
  2. See AdditionalResultAttributeValueTypeDef

CollapsedResultDetailTypeDef#

# CollapsedResultDetailTypeDef definition

class CollapsedResultDetailTypeDef(TypedDict):
    DocumentAttribute: DocumentAttributeOutputTypeDef,  # (1)
    ExpandedResults: NotRequired[list[ExpandedResultItemTypeDef]],  # (2)
  1. See DocumentAttributeOutputTypeDef
  2. See ExpandedResultItemTypeDef

SuggestionTypeDef#

# SuggestionTypeDef definition

class SuggestionTypeDef(TypedDict):
    Id: NotRequired[str],
    Value: NotRequired[SuggestionValueTypeDef],  # (1)
    SourceDocuments: NotRequired[list[SourceDocumentTypeDef]],  # (2)
  1. See SuggestionValueTypeDef
  2. See SourceDocumentTypeDef

DataSourceConfigurationOutputTypeDef#

# DataSourceConfigurationOutputTypeDef definition

class DataSourceConfigurationOutputTypeDef(TypedDict):
    S3Configuration: NotRequired[S3DataSourceConfigurationOutputTypeDef],  # (1)
    SharePointConfiguration: NotRequired[SharePointConfigurationOutputTypeDef],  # (2)
    DatabaseConfiguration: NotRequired[DatabaseConfigurationOutputTypeDef],  # (3)
    SalesforceConfiguration: NotRequired[SalesforceConfigurationOutputTypeDef],  # (4)
    OneDriveConfiguration: NotRequired[OneDriveConfigurationOutputTypeDef],  # (5)
    ServiceNowConfiguration: NotRequired[ServiceNowConfigurationOutputTypeDef],  # (6)
    ConfluenceConfiguration: NotRequired[ConfluenceConfigurationOutputTypeDef],  # (7)
    GoogleDriveConfiguration: NotRequired[GoogleDriveConfigurationOutputTypeDef],  # (8)
    WebCrawlerConfiguration: NotRequired[WebCrawlerConfigurationOutputTypeDef],  # (9)
    WorkDocsConfiguration: NotRequired[WorkDocsConfigurationOutputTypeDef],  # (10)
    FsxConfiguration: NotRequired[FsxConfigurationOutputTypeDef],  # (11)
    SlackConfiguration: NotRequired[SlackConfigurationOutputTypeDef],  # (12)
    BoxConfiguration: NotRequired[BoxConfigurationOutputTypeDef],  # (13)
    QuipConfiguration: NotRequired[QuipConfigurationOutputTypeDef],  # (14)
    JiraConfiguration: NotRequired[JiraConfigurationOutputTypeDef],  # (15)
    GitHubConfiguration: NotRequired[GitHubConfigurationOutputTypeDef],  # (16)
    AlfrescoConfiguration: NotRequired[AlfrescoConfigurationOutputTypeDef],  # (17)
    TemplateConfiguration: NotRequired[TemplateConfigurationOutputTypeDef],  # (18)
  1. See S3DataSourceConfigurationOutputTypeDef
  2. See SharePointConfigurationOutputTypeDef
  3. See DatabaseConfigurationOutputTypeDef
  4. See SalesforceConfigurationOutputTypeDef
  5. See OneDriveConfigurationOutputTypeDef
  6. See ServiceNowConfigurationOutputTypeDef
  7. See ConfluenceConfigurationOutputTypeDef
  8. See GoogleDriveConfigurationOutputTypeDef
  9. See WebCrawlerConfigurationOutputTypeDef
  10. See WorkDocsConfigurationOutputTypeDef
  11. See FsxConfigurationOutputTypeDef
  12. See SlackConfigurationOutputTypeDef
  13. See BoxConfigurationOutputTypeDef
  14. See QuipConfigurationOutputTypeDef
  15. See JiraConfigurationOutputTypeDef
  16. See GitHubConfigurationOutputTypeDef
  17. See AlfrescoConfigurationOutputTypeDef
  18. See TemplateConfigurationOutputTypeDef

FeaturedResultsItemTypeDef#

# FeaturedResultsItemTypeDef definition

class FeaturedResultsItemTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[QueryResultTypeType],  # (1)
    AdditionalAttributes: NotRequired[list[AdditionalResultAttributeTypeDef]],  # (2)
    DocumentId: NotRequired[str],
    DocumentTitle: NotRequired[TextWithHighlightsTypeDef],  # (3)
    DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef],  # (3)
    DocumentURI: NotRequired[str],
    DocumentAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (5)
    FeedbackToken: NotRequired[str],
  1. See QueryResultTypeType
  2. See AdditionalResultAttributeTypeDef
  3. See TextWithHighlightsTypeDef
  4. See TextWithHighlightsTypeDef
  5. See DocumentAttributeOutputTypeDef

QueryResultItemTypeDef#

# QueryResultItemTypeDef definition

class QueryResultItemTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[QueryResultTypeType],  # (1)
    Format: NotRequired[QueryResultFormatType],  # (2)
    AdditionalAttributes: NotRequired[list[AdditionalResultAttributeTypeDef]],  # (3)
    DocumentId: NotRequired[str],
    DocumentTitle: NotRequired[TextWithHighlightsTypeDef],  # (4)
    DocumentExcerpt: NotRequired[TextWithHighlightsTypeDef],  # (4)
    DocumentURI: NotRequired[str],
    DocumentAttributes: NotRequired[list[DocumentAttributeOutputTypeDef]],  # (6)
    ScoreAttributes: NotRequired[ScoreAttributesTypeDef],  # (7)
    FeedbackToken: NotRequired[str],
    TableExcerpt: NotRequired[TableExcerptTypeDef],  # (8)
    CollapsedResultDetail: NotRequired[CollapsedResultDetailTypeDef],  # (9)
  1. See QueryResultTypeType
  2. See QueryResultFormatType
  3. See AdditionalResultAttributeTypeDef
  4. See TextWithHighlightsTypeDef
  5. See TextWithHighlightsTypeDef
  6. See DocumentAttributeOutputTypeDef
  7. See ScoreAttributesTypeDef
  8. See TableExcerptTypeDef
  9. See CollapsedResultDetailTypeDef

UpdateIndexRequestRequestTypeDef#

# UpdateIndexRequestRequestTypeDef definition

class UpdateIndexRequestRequestTypeDef(TypedDict):
    Id: str,
    Name: NotRequired[str],
    RoleArn: NotRequired[str],
    Description: NotRequired[str],
    DocumentMetadataConfigurationUpdates: NotRequired[Sequence[DocumentMetadataConfigurationUnionTypeDef]],  # (1)
    CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef],  # (2)
    UserTokenConfigurations: NotRequired[Sequence[UserTokenConfigurationTypeDef]],  # (3)
    UserContextPolicy: NotRequired[UserContextPolicyType],  # (4)
    UserGroupResolutionConfiguration: NotRequired[UserGroupResolutionConfigurationTypeDef],  # (5)
  1. See DocumentMetadataConfigurationTypeDef DocumentMetadataConfigurationOutputTypeDef
  2. See CapacityUnitsConfigurationTypeDef
  3. See UserTokenConfigurationTypeDef
  4. See UserContextPolicyType
  5. See UserGroupResolutionConfigurationTypeDef

WebCrawlerConfigurationTypeDef#

# WebCrawlerConfigurationTypeDef definition

class WebCrawlerConfigurationTypeDef(TypedDict):
    Urls: UrlsUnionTypeDef,  # (1)
    CrawlDepth: NotRequired[int],
    MaxLinksPerPage: NotRequired[int],
    MaxContentSizePerPageInMegaBytes: NotRequired[float],
    MaxUrlsPerMinuteCrawlRate: NotRequired[int],
    UrlInclusionPatterns: NotRequired[Sequence[str]],
    UrlExclusionPatterns: NotRequired[Sequence[str]],
    ProxyConfiguration: NotRequired[ProxyConfigurationTypeDef],  # (2)
    AuthenticationConfiguration: NotRequired[AuthenticationConfigurationUnionTypeDef],  # (3)
  1. See UrlsTypeDef UrlsOutputTypeDef
  2. See ProxyConfigurationTypeDef
  3. See AuthenticationConfigurationTypeDef AuthenticationConfigurationOutputTypeDef

GetQuerySuggestionsResponseTypeDef#

# GetQuerySuggestionsResponseTypeDef definition

class GetQuerySuggestionsResponseTypeDef(TypedDict):
    QuerySuggestionsId: str,
    Suggestions: list[SuggestionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuggestionTypeDef
  2. See ResponseMetadataTypeDef

DescribeDataSourceResponseTypeDef#

# DescribeDataSourceResponseTypeDef definition

class DescribeDataSourceResponseTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Name: str,
    Type: DataSourceTypeType,  # (1)
    Configuration: DataSourceConfigurationOutputTypeDef,  # (2)
    VpcConfiguration: DataSourceVpcConfigurationOutputTypeDef,  # (3)
    CreatedAt: datetime,
    UpdatedAt: datetime,
    Description: str,
    Status: DataSourceStatusType,  # (4)
    Schedule: str,
    RoleArn: str,
    ErrorMessage: str,
    LanguageCode: str,
    CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationOutputTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See DataSourceTypeType
  2. See DataSourceConfigurationOutputTypeDef
  3. See DataSourceVpcConfigurationOutputTypeDef
  4. See DataSourceStatusType
  5. See CustomDocumentEnrichmentConfigurationOutputTypeDef
  6. See ResponseMetadataTypeDef

SalesforceConfigurationTypeDef#

# SalesforceConfigurationTypeDef definition

class SalesforceConfigurationTypeDef(TypedDict):
    ServerUrl: str,
    SecretArn: str,
    StandardObjectConfigurations: NotRequired[Sequence[SalesforceStandardObjectConfigurationUnionTypeDef]],  # (1)
    KnowledgeArticleConfiguration: NotRequired[SalesforceKnowledgeArticleConfigurationUnionTypeDef],  # (2)
    ChatterFeedConfiguration: NotRequired[SalesforceChatterFeedConfigurationUnionTypeDef],  # (3)
    CrawlAttachments: NotRequired[bool],
    StandardObjectAttachmentConfiguration: NotRequired[SalesforceStandardObjectAttachmentConfigurationUnionTypeDef],  # (4)
    IncludeAttachmentFilePatterns: NotRequired[Sequence[str]],
    ExcludeAttachmentFilePatterns: NotRequired[Sequence[str]],
  1. See SalesforceStandardObjectConfigurationTypeDef SalesforceStandardObjectConfigurationOutputTypeDef
  2. See SalesforceKnowledgeArticleConfigurationTypeDef SalesforceKnowledgeArticleConfigurationOutputTypeDef
  3. See SalesforceChatterFeedConfigurationTypeDef SalesforceChatterFeedConfigurationOutputTypeDef
  4. See SalesforceStandardObjectAttachmentConfigurationTypeDef SalesforceStandardObjectAttachmentConfigurationOutputTypeDef

HookConfigurationTypeDef#

# HookConfigurationTypeDef definition

class HookConfigurationTypeDef(TypedDict):
    LambdaArn: str,
    S3Bucket: str,
    InvocationCondition: NotRequired[DocumentAttributeConditionUnionTypeDef],  # (1)
  1. See DocumentAttributeConditionTypeDef DocumentAttributeConditionOutputTypeDef

InlineCustomDocumentEnrichmentConfigurationTypeDef#

# InlineCustomDocumentEnrichmentConfigurationTypeDef definition

class InlineCustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
    Condition: NotRequired[DocumentAttributeConditionUnionTypeDef],  # (1)
    Target: NotRequired[DocumentAttributeTargetUnionTypeDef],  # (2)
    DocumentContentDeletion: NotRequired[bool],
  1. See DocumentAttributeConditionTypeDef DocumentAttributeConditionOutputTypeDef
  2. See DocumentAttributeTargetTypeDef DocumentAttributeTargetOutputTypeDef

AttributeFilterTypeDef#

# AttributeFilterTypeDef definition

class AttributeFilterTypeDef(TypedDict):
    AndAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    OrAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
    NotFilter: NotRequired[Mapping[str, Any]],
    EqualsTo: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    ContainsAll: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    ContainsAny: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    GreaterThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    GreaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    LessThan: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
    LessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef],  # (1)
  1. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  2. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  3. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  4. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  5. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  6. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  7. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef

DocumentInfoTypeDef#

# DocumentInfoTypeDef definition

class DocumentInfoTypeDef(TypedDict):
    DocumentId: str,
    Attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]],  # (1)
  1. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    Id: str,
    Title: NotRequired[str],
    Blob: NotRequired[BlobTypeDef],
    S3Path: NotRequired[S3PathTypeDef],  # (1)
    Attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]],  # (2)
    AccessControlList: NotRequired[Sequence[PrincipalTypeDef]],  # (3)
    HierarchicalAccessControlList: NotRequired[Sequence[HierarchicalPrincipalUnionTypeDef]],  # (4)
    ContentType: NotRequired[ContentTypeType],  # (5)
    AccessControlConfigurationId: NotRequired[str],
  1. See S3PathTypeDef
  2. See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
  3. See PrincipalTypeDef
  4. See HierarchicalPrincipalTypeDef HierarchicalPrincipalOutputTypeDef
  5. See ContentTypeType

QueryResultTypeDef#

# QueryResultTypeDef definition

class QueryResultTypeDef(TypedDict):
    QueryId: str,
    ResultItems: list[QueryResultItemTypeDef],  # (1)
    FacetResults: list[FacetResultTypeDef],  # (2)
    TotalNumberOfResults: int,
    Warnings: list[WarningTypeDef],  # (3)
    SpellCorrectedQueries: list[SpellCorrectedQueryTypeDef],  # (4)
    FeaturedResultsItems: list[FeaturedResultsItemTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See QueryResultItemTypeDef
  2. See FacetResultTypeDef
  3. See WarningTypeDef
  4. See SpellCorrectedQueryTypeDef
  5. See FeaturedResultsItemTypeDef
  6. See ResponseMetadataTypeDef

AttributeSuggestionsGetConfigTypeDef#

# AttributeSuggestionsGetConfigTypeDef definition

class AttributeSuggestionsGetConfigTypeDef(TypedDict):
    SuggestionAttributes: NotRequired[Sequence[str]],
    AdditionalResponseAttributes: NotRequired[Sequence[str]],
    AttributeFilter: NotRequired[AttributeFilterTypeDef],  # (1)
    UserContext: NotRequired[UserContextTypeDef],  # (2)
  1. See AttributeFilterTypeDef
  2. See UserContextTypeDef

QueryRequestRequestTypeDef#

# QueryRequestRequestTypeDef definition

class QueryRequestRequestTypeDef(TypedDict):
    IndexId: str,
    QueryText: NotRequired[str],
    AttributeFilter: NotRequired[AttributeFilterTypeDef],  # (1)
    Facets: NotRequired[Sequence[FacetTypeDef]],  # (2)
    RequestedDocumentAttributes: NotRequired[Sequence[str]],
    QueryResultTypeFilter: NotRequired[QueryResultTypeType],  # (3)
    DocumentRelevanceOverrideConfigurations: NotRequired[Sequence[DocumentRelevanceConfigurationTypeDef]],  # (4)
    PageNumber: NotRequired[int],
    PageSize: NotRequired[int],
    SortingConfiguration: NotRequired[SortingConfigurationTypeDef],  # (5)
    SortingConfigurations: NotRequired[Sequence[SortingConfigurationTypeDef]],  # (6)
    UserContext: NotRequired[UserContextTypeDef],  # (7)
    VisitorId: NotRequired[str],
    SpellCorrectionConfiguration: NotRequired[SpellCorrectionConfigurationTypeDef],  # (8)
    CollapseConfiguration: NotRequired[CollapseConfigurationTypeDef],  # (9)
  1. See AttributeFilterTypeDef
  2. See FacetTypeDef
  3. See QueryResultTypeType
  4. See DocumentRelevanceConfigurationTypeDef
  5. See SortingConfigurationTypeDef
  6. See SortingConfigurationTypeDef
  7. See UserContextTypeDef
  8. See SpellCorrectionConfigurationTypeDef
  9. See CollapseConfigurationTypeDef

RetrieveRequestRequestTypeDef#

# RetrieveRequestRequestTypeDef definition

class RetrieveRequestRequestTypeDef(TypedDict):
    IndexId: str,
    QueryText: str,
    AttributeFilter: NotRequired[AttributeFilterTypeDef],  # (1)
    RequestedDocumentAttributes: NotRequired[Sequence[str]],
    DocumentRelevanceOverrideConfigurations: NotRequired[Sequence[DocumentRelevanceConfigurationTypeDef]],  # (2)
    PageNumber: NotRequired[int],
    PageSize: NotRequired[int],
    UserContext: NotRequired[UserContextTypeDef],  # (3)
  1. See AttributeFilterTypeDef
  2. See DocumentRelevanceConfigurationTypeDef
  3. See UserContextTypeDef

BatchGetDocumentStatusRequestRequestTypeDef#

# BatchGetDocumentStatusRequestRequestTypeDef definition

class BatchGetDocumentStatusRequestRequestTypeDef(TypedDict):
    IndexId: str,
    DocumentInfoList: Sequence[DocumentInfoTypeDef],  # (1)
  1. See DocumentInfoTypeDef

DataSourceConfigurationTypeDef#

# DataSourceConfigurationTypeDef definition

class DataSourceConfigurationTypeDef(TypedDict):
    S3Configuration: NotRequired[S3DataSourceConfigurationUnionTypeDef],  # (1)
    SharePointConfiguration: NotRequired[SharePointConfigurationUnionTypeDef],  # (2)
    DatabaseConfiguration: NotRequired[DatabaseConfigurationUnionTypeDef],  # (3)
    SalesforceConfiguration: NotRequired[SalesforceConfigurationUnionTypeDef],  # (4)
    OneDriveConfiguration: NotRequired[OneDriveConfigurationUnionTypeDef],  # (5)
    ServiceNowConfiguration: NotRequired[ServiceNowConfigurationUnionTypeDef],  # (6)
    ConfluenceConfiguration: NotRequired[ConfluenceConfigurationUnionTypeDef],  # (7)
    GoogleDriveConfiguration: NotRequired[GoogleDriveConfigurationUnionTypeDef],  # (8)
    WebCrawlerConfiguration: NotRequired[WebCrawlerConfigurationUnionTypeDef],  # (9)
    WorkDocsConfiguration: NotRequired[WorkDocsConfigurationUnionTypeDef],  # (10)
    FsxConfiguration: NotRequired[FsxConfigurationUnionTypeDef],  # (11)
    SlackConfiguration: NotRequired[SlackConfigurationUnionTypeDef],  # (12)
    BoxConfiguration: NotRequired[BoxConfigurationUnionTypeDef],  # (13)
    QuipConfiguration: NotRequired[QuipConfigurationUnionTypeDef],  # (14)
    JiraConfiguration: NotRequired[JiraConfigurationUnionTypeDef],  # (15)
    GitHubConfiguration: NotRequired[GitHubConfigurationUnionTypeDef],  # (16)
    AlfrescoConfiguration: NotRequired[AlfrescoConfigurationUnionTypeDef],  # (17)
    TemplateConfiguration: NotRequired[TemplateConfigurationUnionTypeDef],  # (18)
  1. See S3DataSourceConfigurationTypeDef S3DataSourceConfigurationOutputTypeDef
  2. See SharePointConfigurationTypeDef SharePointConfigurationOutputTypeDef
  3. See DatabaseConfigurationTypeDef DatabaseConfigurationOutputTypeDef
  4. See SalesforceConfigurationTypeDef SalesforceConfigurationOutputTypeDef
  5. See OneDriveConfigurationTypeDef OneDriveConfigurationOutputTypeDef
  6. See ServiceNowConfigurationTypeDef ServiceNowConfigurationOutputTypeDef
  7. See ConfluenceConfigurationTypeDef ConfluenceConfigurationOutputTypeDef
  8. See GoogleDriveConfigurationTypeDef GoogleDriveConfigurationOutputTypeDef
  9. See WebCrawlerConfigurationTypeDef WebCrawlerConfigurationOutputTypeDef
  10. See WorkDocsConfigurationTypeDef WorkDocsConfigurationOutputTypeDef
  11. See FsxConfigurationTypeDef FsxConfigurationOutputTypeDef
  12. See SlackConfigurationTypeDef SlackConfigurationOutputTypeDef
  13. See BoxConfigurationTypeDef BoxConfigurationOutputTypeDef
  14. See QuipConfigurationTypeDef QuipConfigurationOutputTypeDef
  15. See JiraConfigurationTypeDef JiraConfigurationOutputTypeDef
  16. See GitHubConfigurationTypeDef GitHubConfigurationOutputTypeDef
  17. See AlfrescoConfigurationTypeDef AlfrescoConfigurationOutputTypeDef
  18. See TemplateConfigurationTypeDef TemplateConfigurationOutputTypeDef

CustomDocumentEnrichmentConfigurationTypeDef#

# CustomDocumentEnrichmentConfigurationTypeDef definition

class CustomDocumentEnrichmentConfigurationTypeDef(TypedDict):
    InlineConfigurations: NotRequired[Sequence[InlineCustomDocumentEnrichmentConfigurationUnionTypeDef]],  # (1)
    PreExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)
    PostExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef],  # (2)
    RoleArn: NotRequired[str],
  1. See InlineCustomDocumentEnrichmentConfigurationTypeDef InlineCustomDocumentEnrichmentConfigurationOutputTypeDef
  2. See HookConfigurationTypeDef HookConfigurationOutputTypeDef
  3. See HookConfigurationTypeDef HookConfigurationOutputTypeDef

GetQuerySuggestionsRequestRequestTypeDef#

# GetQuerySuggestionsRequestRequestTypeDef definition

class GetQuerySuggestionsRequestRequestTypeDef(TypedDict):
    IndexId: str,
    QueryText: str,
    MaxSuggestionsCount: NotRequired[int],
    SuggestionTypes: NotRequired[Sequence[SuggestionTypeType]],  # (1)
    AttributeSuggestionsConfig: NotRequired[AttributeSuggestionsGetConfigTypeDef],  # (2)
  1. See SuggestionTypeType
  2. See AttributeSuggestionsGetConfigTypeDef

BatchPutDocumentRequestRequestTypeDef#

# BatchPutDocumentRequestRequestTypeDef definition

class BatchPutDocumentRequestRequestTypeDef(TypedDict):
    IndexId: str,
    Documents: Sequence[DocumentTypeDef],  # (1)
    RoleArn: NotRequired[str],
    CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef],  # (2)
  1. See DocumentTypeDef
  2. See CustomDocumentEnrichmentConfigurationTypeDef

CreateDataSourceRequestRequestTypeDef#

# CreateDataSourceRequestRequestTypeDef definition

class CreateDataSourceRequestRequestTypeDef(TypedDict):
    Name: str,
    IndexId: str,
    Type: DataSourceTypeType,  # (1)
    Configuration: NotRequired[DataSourceConfigurationTypeDef],  # (2)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (3)
    Description: NotRequired[str],
    Schedule: NotRequired[str],
    RoleArn: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    ClientToken: NotRequired[str],
    LanguageCode: NotRequired[str],
    CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef],  # (5)
  1. See DataSourceTypeType
  2. See DataSourceConfigurationTypeDef
  3. See DataSourceVpcConfigurationTypeDef
  4. See TagTypeDef
  5. See CustomDocumentEnrichmentConfigurationTypeDef

UpdateDataSourceRequestRequestTypeDef#

# UpdateDataSourceRequestRequestTypeDef definition

class UpdateDataSourceRequestRequestTypeDef(TypedDict):
    Id: str,
    IndexId: str,
    Name: NotRequired[str],
    Configuration: NotRequired[DataSourceConfigurationTypeDef],  # (1)
    VpcConfiguration: NotRequired[DataSourceVpcConfigurationTypeDef],  # (2)
    Description: NotRequired[str],
    Schedule: NotRequired[str],
    RoleArn: NotRequired[str],
    LanguageCode: NotRequired[str],
    CustomDocumentEnrichmentConfiguration: NotRequired[CustomDocumentEnrichmentConfigurationTypeDef],  # (3)
  1. See DataSourceConfigurationTypeDef
  2. See DataSourceVpcConfigurationTypeDef
  3. See CustomDocumentEnrichmentConfigurationTypeDef