Skip to content

Type definitions#

Index > ConnectWisdomService > Type definitions

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

AppIntegrationsConfigurationPaginatorTypeDef#

# AppIntegrationsConfigurationPaginatorTypeDef definition

class AppIntegrationsConfigurationPaginatorTypeDef(TypedDict):
    appIntegrationArn: str,
    objectFields: NotRequired[List[str]],

AppIntegrationsConfigurationTypeDef#

# AppIntegrationsConfigurationTypeDef definition

class AppIntegrationsConfigurationTypeDef(TypedDict):
    appIntegrationArn: str,
    objectFields: NotRequired[Sequence[str]],

AssistantAssociationInputDataTypeDef#

# AssistantAssociationInputDataTypeDef definition

class AssistantAssociationInputDataTypeDef(TypedDict):
    knowledgeBaseId: NotRequired[str],

KnowledgeBaseAssociationDataTypeDef#

# KnowledgeBaseAssociationDataTypeDef definition

class KnowledgeBaseAssociationDataTypeDef(TypedDict):
    knowledgeBaseArn: NotRequired[str],
    knowledgeBaseId: NotRequired[str],

AssistantIntegrationConfigurationTypeDef#

# AssistantIntegrationConfigurationTypeDef definition

class AssistantIntegrationConfigurationTypeDef(TypedDict):
    topicIntegrationArn: NotRequired[str],

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef definition

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

ConnectConfigurationTypeDef#

# ConnectConfigurationTypeDef definition

class ConnectConfigurationTypeDef(TypedDict):
    instanceId: NotRequired[str],

ContentDataTypeDef#

# ContentDataTypeDef definition

class ContentDataTypeDef(TypedDict):
    contentArn: str,
    contentId: str,
    contentType: str,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    metadata: Dict[str, str],
    name: str,
    revisionId: str,
    status: ContentStatusType,  # (1)
    title: str,
    url: str,
    urlExpiry: datetime,
    linkOutUri: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See ContentStatusType

ContentReferenceTypeDef#

# ContentReferenceTypeDef definition

class ContentReferenceTypeDef(TypedDict):
    contentArn: NotRequired[str],
    contentId: NotRequired[str],
    knowledgeBaseArn: NotRequired[str],
    knowledgeBaseId: NotRequired[str],

ContentSummaryTypeDef#

# ContentSummaryTypeDef definition

class ContentSummaryTypeDef(TypedDict):
    contentArn: str,
    contentId: str,
    contentType: str,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    metadata: Dict[str, str],
    name: str,
    revisionId: str,
    status: ContentStatusType,  # (1)
    title: str,
    tags: NotRequired[Dict[str, str]],
  1. See ContentStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateContentRequestRequestTypeDef#

# CreateContentRequestRequestTypeDef definition

class CreateContentRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    name: str,
    uploadId: str,
    clientToken: NotRequired[str],
    metadata: NotRequired[Mapping[str, str]],
    overrideLinkOutUri: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    title: NotRequired[str],

RenderingConfigurationTypeDef#

# RenderingConfigurationTypeDef definition

class RenderingConfigurationTypeDef(TypedDict):
    templateUri: NotRequired[str],

GroupingConfigurationTypeDef#

# GroupingConfigurationTypeDef definition

class GroupingConfigurationTypeDef(TypedDict):
    criteria: NotRequired[str],
    values: NotRequired[Sequence[str]],

QuickResponseDataProviderTypeDef#

# QuickResponseDataProviderTypeDef definition

class QuickResponseDataProviderTypeDef(TypedDict):
    content: NotRequired[str],

CreateSessionRequestRequestTypeDef#

# CreateSessionRequestRequestTypeDef definition

class CreateSessionRequestRequestTypeDef(TypedDict):
    assistantId: str,
    name: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

DeleteAssistantAssociationRequestRequestTypeDef#

# DeleteAssistantAssociationRequestRequestTypeDef definition

class DeleteAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantAssociationId: str,
    assistantId: str,

DeleteAssistantRequestRequestTypeDef#

# DeleteAssistantRequestRequestTypeDef definition

class DeleteAssistantRequestRequestTypeDef(TypedDict):
    assistantId: str,

DeleteContentRequestRequestTypeDef#

# DeleteContentRequestRequestTypeDef definition

class DeleteContentRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

DeleteImportJobRequestRequestTypeDef#

# DeleteImportJobRequestRequestTypeDef definition

class DeleteImportJobRequestRequestTypeDef(TypedDict):
    importJobId: str,
    knowledgeBaseId: str,

DeleteKnowledgeBaseRequestRequestTypeDef#

# DeleteKnowledgeBaseRequestRequestTypeDef definition

class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

DeleteQuickResponseRequestRequestTypeDef#

# DeleteQuickResponseRequestRequestTypeDef definition

class DeleteQuickResponseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    quickResponseId: str,

HighlightTypeDef#

# HighlightTypeDef definition

class HighlightTypeDef(TypedDict):
    beginOffsetInclusive: NotRequired[int],
    endOffsetExclusive: NotRequired[int],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    field: FilterFieldType,  # (1)
    operator: FilterOperatorType,  # (2)
    value: str,
  1. See FilterFieldType
  2. See FilterOperatorType

GetAssistantAssociationRequestRequestTypeDef#

# GetAssistantAssociationRequestRequestTypeDef definition

class GetAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantAssociationId: str,
    assistantId: str,

GetAssistantRequestRequestTypeDef#

# GetAssistantRequestRequestTypeDef definition

class GetAssistantRequestRequestTypeDef(TypedDict):
    assistantId: str,

GetContentRequestRequestTypeDef#

# GetContentRequestRequestTypeDef definition

class GetContentRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

GetContentSummaryRequestRequestTypeDef#

# GetContentSummaryRequestRequestTypeDef definition

class GetContentSummaryRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,

GetImportJobRequestRequestTypeDef#

# GetImportJobRequestRequestTypeDef definition

class GetImportJobRequestRequestTypeDef(TypedDict):
    importJobId: str,
    knowledgeBaseId: str,

GetKnowledgeBaseRequestRequestTypeDef#

# GetKnowledgeBaseRequestRequestTypeDef definition

class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

GetQuickResponseRequestRequestTypeDef#

# GetQuickResponseRequestRequestTypeDef definition

class GetQuickResponseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    quickResponseId: str,

GetRecommendationsRequestRequestTypeDef#

# GetRecommendationsRequestRequestTypeDef definition

class GetRecommendationsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    sessionId: str,
    maxResults: NotRequired[int],
    waitTimeSeconds: NotRequired[int],

GetSessionRequestRequestTypeDef#

# GetSessionRequestRequestTypeDef definition

class GetSessionRequestRequestTypeDef(TypedDict):
    assistantId: str,
    sessionId: str,

GroupingConfigurationPaginatorTypeDef#

# GroupingConfigurationPaginatorTypeDef definition

class GroupingConfigurationPaginatorTypeDef(TypedDict):
    criteria: NotRequired[str],
    values: NotRequired[List[str]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAssistantAssociationsRequestRequestTypeDef#

# ListAssistantAssociationsRequestRequestTypeDef definition

class ListAssistantAssociationsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAssistantsRequestRequestTypeDef#

# ListAssistantsRequestRequestTypeDef definition

class ListAssistantsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListContentsRequestRequestTypeDef#

# ListContentsRequestRequestTypeDef definition

class ListContentsRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListImportJobsRequestRequestTypeDef#

# ListImportJobsRequestRequestTypeDef definition

class ListImportJobsRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListKnowledgeBasesRequestRequestTypeDef#

# ListKnowledgeBasesRequestRequestTypeDef definition

class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListQuickResponsesRequestRequestTypeDef#

# ListQuickResponsesRequestRequestTypeDef definition

class ListQuickResponsesRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

QuickResponseSummaryTypeDef#

# QuickResponseSummaryTypeDef definition

class QuickResponseSummaryTypeDef(TypedDict):
    contentType: str,
    createdTime: datetime,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    name: str,
    quickResponseArn: str,
    quickResponseId: str,
    status: QuickResponseStatusType,  # (1)
    channels: NotRequired[List[str]],
    description: NotRequired[str],
    isActive: NotRequired[bool],
    lastModifiedBy: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See QuickResponseStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

NotifyRecommendationsReceivedErrorTypeDef#

# NotifyRecommendationsReceivedErrorTypeDef definition

class NotifyRecommendationsReceivedErrorTypeDef(TypedDict):
    message: NotRequired[str],
    recommendationId: NotRequired[str],

NotifyRecommendationsReceivedRequestRequestTypeDef#

# NotifyRecommendationsReceivedRequestRequestTypeDef definition

class NotifyRecommendationsReceivedRequestRequestTypeDef(TypedDict):
    assistantId: str,
    recommendationIds: Sequence[str],
    sessionId: str,

QueryAssistantRequestRequestTypeDef#

# QueryAssistantRequestRequestTypeDef definition

class QueryAssistantRequestRequestTypeDef(TypedDict):
    assistantId: str,
    queryText: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

QueryRecommendationTriggerDataTypeDef#

# QueryRecommendationTriggerDataTypeDef definition

class QueryRecommendationTriggerDataTypeDef(TypedDict):
    text: NotRequired[str],

QuickResponseContentProviderTypeDef#

# QuickResponseContentProviderTypeDef definition

class QuickResponseContentProviderTypeDef(TypedDict):
    content: NotRequired[str],

QuickResponseFilterFieldTypeDef#

# QuickResponseFilterFieldTypeDef definition

class QuickResponseFilterFieldTypeDef(TypedDict):
    name: str,
    operator: QuickResponseFilterOperatorType,  # (1)
    includeNoExistence: NotRequired[bool],
    values: NotRequired[Sequence[str]],
  1. See QuickResponseFilterOperatorType

QuickResponseOrderFieldTypeDef#

# QuickResponseOrderFieldTypeDef definition

class QuickResponseOrderFieldTypeDef(TypedDict):
    name: str,
    order: NotRequired[OrderType],  # (1)
  1. See OrderType

QuickResponseQueryFieldTypeDef#

# QuickResponseQueryFieldTypeDef definition

class QuickResponseQueryFieldTypeDef(TypedDict):
    name: str,
    operator: QuickResponseQueryOperatorType,  # (1)
    values: Sequence[str],
    allowFuzziness: NotRequired[bool],
    priority: NotRequired[PriorityType],  # (2)
  1. See QuickResponseQueryOperatorType
  2. See PriorityType

RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef#

# RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef definition

class RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

SessionSummaryTypeDef#

# SessionSummaryTypeDef definition

class SessionSummaryTypeDef(TypedDict):
    assistantArn: str,
    assistantId: str,
    sessionArn: str,
    sessionId: str,

SessionIntegrationConfigurationTypeDef#

# SessionIntegrationConfigurationTypeDef definition

class SessionIntegrationConfigurationTypeDef(TypedDict):
    topicIntegrationArn: NotRequired[str],

StartContentUploadRequestRequestTypeDef#

# StartContentUploadRequestRequestTypeDef definition

class StartContentUploadRequestRequestTypeDef(TypedDict):
    contentType: str,
    knowledgeBaseId: str,
    presignedUrlTimeToLive: NotRequired[int],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateContentRequestRequestTypeDef#

# UpdateContentRequestRequestTypeDef definition

class UpdateContentRequestRequestTypeDef(TypedDict):
    contentId: str,
    knowledgeBaseId: str,
    metadata: NotRequired[Mapping[str, str]],
    overrideLinkOutUri: NotRequired[str],
    removeOverrideLinkOutUri: NotRequired[bool],
    revisionId: NotRequired[str],
    title: NotRequired[str],
    uploadId: NotRequired[str],

UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef#

# UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef definition

class UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    templateUri: str,

SourceConfigurationPaginatorTypeDef#

# SourceConfigurationPaginatorTypeDef definition

class SourceConfigurationPaginatorTypeDef(TypedDict):
    appIntegrations: NotRequired[AppIntegrationsConfigurationPaginatorTypeDef],  # (1)
  1. See AppIntegrationsConfigurationPaginatorTypeDef

SourceConfigurationTypeDef#

# SourceConfigurationTypeDef definition

class SourceConfigurationTypeDef(TypedDict):
    appIntegrations: NotRequired[AppIntegrationsConfigurationTypeDef],  # (1)
  1. See AppIntegrationsConfigurationTypeDef

CreateAssistantAssociationRequestRequestTypeDef#

# CreateAssistantAssociationRequestRequestTypeDef definition

class CreateAssistantAssociationRequestRequestTypeDef(TypedDict):
    assistantId: str,
    association: AssistantAssociationInputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See AssistantAssociationInputDataTypeDef
  2. See AssociationTypeType

AssistantAssociationOutputDataTypeDef#

# AssistantAssociationOutputDataTypeDef definition

class AssistantAssociationOutputDataTypeDef(TypedDict):
    knowledgeBaseAssociation: NotRequired[KnowledgeBaseAssociationDataTypeDef],  # (1)
  1. See KnowledgeBaseAssociationDataTypeDef

AssistantDataTypeDef#

# AssistantDataTypeDef definition

class AssistantDataTypeDef(TypedDict):
    assistantArn: str,
    assistantId: str,
    name: str,
    status: AssistantStatusType,  # (3)
    type: AssistantTypeType,  # (4)
    description: NotRequired[str],
    integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef],  # (1)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See AssistantIntegrationConfigurationTypeDef
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See AssistantStatusType
  4. See AssistantTypeType

AssistantSummaryTypeDef#

# AssistantSummaryTypeDef definition

class AssistantSummaryTypeDef(TypedDict):
    assistantArn: str,
    assistantId: str,
    name: str,
    status: AssistantStatusType,  # (3)
    type: AssistantTypeType,  # (4)
    description: NotRequired[str],
    integrationConfiguration: NotRequired[AssistantIntegrationConfigurationTypeDef],  # (1)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See AssistantIntegrationConfigurationTypeDef
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See AssistantStatusType
  4. See AssistantTypeType

CreateAssistantRequestRequestTypeDef#

# CreateAssistantRequestRequestTypeDef definition

class CreateAssistantRequestRequestTypeDef(TypedDict):
    name: str,
    type: AssistantTypeType,  # (1)
    clientToken: NotRequired[str],
    description: NotRequired[str],
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See AssistantTypeType
  2. See ServerSideEncryptionConfigurationTypeDef

ConfigurationTypeDef#

# ConfigurationTypeDef definition

class ConfigurationTypeDef(TypedDict):
    connectConfiguration: NotRequired[ConnectConfigurationTypeDef],  # (1)
  1. See ConnectConfigurationTypeDef

CreateContentResponseTypeDef#

# CreateContentResponseTypeDef definition

class CreateContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

GetContentResponseTypeDef#

# GetContentResponseTypeDef definition

class GetContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

GetContentSummaryResponseTypeDef#

# GetContentSummaryResponseTypeDef definition

class GetContentSummaryResponseTypeDef(TypedDict):
    contentSummary: ContentSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListContentsResponseTypeDef#

# ListContentsResponseTypeDef definition

class ListContentsResponseTypeDef(TypedDict):
    contentSummaries: List[ContentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SearchContentResponseTypeDef#

# SearchContentResponseTypeDef definition

class SearchContentResponseTypeDef(TypedDict):
    contentSummaries: List[ContentSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentSummaryTypeDef
  2. See ResponseMetadataTypeDef

StartContentUploadResponseTypeDef#

# StartContentUploadResponseTypeDef definition

class StartContentUploadResponseTypeDef(TypedDict):
    headersToInclude: Dict[str, str],
    uploadId: str,
    url: str,
    urlExpiry: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateContentResponseTypeDef#

# UpdateContentResponseTypeDef definition

class UpdateContentResponseTypeDef(TypedDict):
    content: ContentDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentDataTypeDef
  2. See ResponseMetadataTypeDef

CreateQuickResponseRequestRequestTypeDef#

# CreateQuickResponseRequestRequestTypeDef definition

class CreateQuickResponseRequestRequestTypeDef(TypedDict):
    content: QuickResponseDataProviderTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    channels: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],
    contentType: NotRequired[str],
    description: NotRequired[str],
    groupingConfiguration: NotRequired[GroupingConfigurationTypeDef],  # (2)
    isActive: NotRequired[bool],
    language: NotRequired[str],
    shortcutKey: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationTypeDef

UpdateQuickResponseRequestRequestTypeDef#

# UpdateQuickResponseRequestRequestTypeDef definition

class UpdateQuickResponseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    quickResponseId: str,
    channels: NotRequired[Sequence[str]],
    content: NotRequired[QuickResponseDataProviderTypeDef],  # (1)
    contentType: NotRequired[str],
    description: NotRequired[str],
    groupingConfiguration: NotRequired[GroupingConfigurationTypeDef],  # (2)
    isActive: NotRequired[bool],
    language: NotRequired[str],
    name: NotRequired[str],
    removeDescription: NotRequired[bool],
    removeGroupingConfiguration: NotRequired[bool],
    removeShortcutKey: NotRequired[bool],
    shortcutKey: NotRequired[str],
  1. See QuickResponseDataProviderTypeDef
  2. See GroupingConfigurationTypeDef

DocumentTextTypeDef#

# DocumentTextTypeDef definition

class DocumentTextTypeDef(TypedDict):
    highlights: NotRequired[List[HighlightTypeDef]],  # (1)
    text: NotRequired[str],
  1. See HighlightTypeDef

SearchExpressionTypeDef#

# SearchExpressionTypeDef definition

class SearchExpressionTypeDef(TypedDict):
    filters: Sequence[FilterTypeDef],  # (1)
  1. See FilterTypeDef

ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef#

# ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef definition

class ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef(TypedDict):
    assistantId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAssistantsRequestListAssistantsPaginateTypeDef#

# ListAssistantsRequestListAssistantsPaginateTypeDef definition

class ListAssistantsRequestListAssistantsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListContentsRequestListContentsPaginateTypeDef#

# ListContentsRequestListContentsPaginateTypeDef definition

class ListContentsRequestListContentsPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListImportJobsRequestListImportJobsPaginateTypeDef#

# ListImportJobsRequestListImportJobsPaginateTypeDef definition

class ListImportJobsRequestListImportJobsPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef#

# ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef definition

class ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQuickResponsesRequestListQuickResponsesPaginateTypeDef#

# ListQuickResponsesRequestListQuickResponsesPaginateTypeDef definition

class ListQuickResponsesRequestListQuickResponsesPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

QueryAssistantRequestQueryAssistantPaginateTypeDef#

# QueryAssistantRequestQueryAssistantPaginateTypeDef definition

class QueryAssistantRequestQueryAssistantPaginateTypeDef(TypedDict):
    assistantId: str,
    queryText: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQuickResponsesResponseTypeDef#

# ListQuickResponsesResponseTypeDef definition

class ListQuickResponsesResponseTypeDef(TypedDict):
    nextToken: str,
    quickResponseSummaries: List[QuickResponseSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseSummaryTypeDef
  2. See ResponseMetadataTypeDef

NotifyRecommendationsReceivedResponseTypeDef#

# NotifyRecommendationsReceivedResponseTypeDef definition

class NotifyRecommendationsReceivedResponseTypeDef(TypedDict):
    errors: List[NotifyRecommendationsReceivedErrorTypeDef],  # (1)
    recommendationIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotifyRecommendationsReceivedErrorTypeDef
  2. See ResponseMetadataTypeDef

RecommendationTriggerDataTypeDef#

# RecommendationTriggerDataTypeDef definition

class RecommendationTriggerDataTypeDef(TypedDict):
    query: NotRequired[QueryRecommendationTriggerDataTypeDef],  # (1)
  1. See QueryRecommendationTriggerDataTypeDef

QuickResponseContentsTypeDef#

# QuickResponseContentsTypeDef definition

class QuickResponseContentsTypeDef(TypedDict):
    markdown: NotRequired[QuickResponseContentProviderTypeDef],  # (1)
    plainText: NotRequired[QuickResponseContentProviderTypeDef],  # (1)
  1. See QuickResponseContentProviderTypeDef
  2. See QuickResponseContentProviderTypeDef

QuickResponseSearchExpressionTypeDef#

# QuickResponseSearchExpressionTypeDef definition

class QuickResponseSearchExpressionTypeDef(TypedDict):
    filters: NotRequired[Sequence[QuickResponseFilterFieldTypeDef]],  # (1)
    orderOnField: NotRequired[QuickResponseOrderFieldTypeDef],  # (2)
    queries: NotRequired[Sequence[QuickResponseQueryFieldTypeDef]],  # (3)
  1. See QuickResponseFilterFieldTypeDef
  2. See QuickResponseOrderFieldTypeDef
  3. See QuickResponseQueryFieldTypeDef

SearchSessionsResponseTypeDef#

# SearchSessionsResponseTypeDef definition

class SearchSessionsResponseTypeDef(TypedDict):
    nextToken: str,
    sessionSummaries: List[SessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

SessionDataTypeDef#

# SessionDataTypeDef definition

class SessionDataTypeDef(TypedDict):
    name: str,
    sessionArn: str,
    sessionId: str,
    description: NotRequired[str],
    integrationConfiguration: NotRequired[SessionIntegrationConfigurationTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See SessionIntegrationConfigurationTypeDef

KnowledgeBaseSummaryPaginatorTypeDef#

# KnowledgeBaseSummaryPaginatorTypeDef definition

class KnowledgeBaseSummaryPaginatorTypeDef(TypedDict):
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    status: KnowledgeBaseStatusType,  # (5)
    description: NotRequired[str],
    renderingConfiguration: NotRequired[RenderingConfigurationTypeDef],  # (2)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    sourceConfiguration: NotRequired[SourceConfigurationPaginatorTypeDef],  # (4)
    tags: NotRequired[Dict[str, str]],
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationPaginatorTypeDef
  5. See KnowledgeBaseStatusType

CreateKnowledgeBaseRequestRequestTypeDef#

# CreateKnowledgeBaseRequestRequestTypeDef definition

class CreateKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    renderingConfiguration: NotRequired[RenderingConfigurationTypeDef],  # (2)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    sourceConfiguration: NotRequired[SourceConfigurationTypeDef],  # (4)
    tags: NotRequired[Mapping[str, str]],
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationTypeDef

KnowledgeBaseDataTypeDef#

# KnowledgeBaseDataTypeDef definition

class KnowledgeBaseDataTypeDef(TypedDict):
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    status: KnowledgeBaseStatusType,  # (5)
    description: NotRequired[str],
    lastContentModificationTime: NotRequired[datetime],
    renderingConfiguration: NotRequired[RenderingConfigurationTypeDef],  # (2)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    sourceConfiguration: NotRequired[SourceConfigurationTypeDef],  # (4)
    tags: NotRequired[Dict[str, str]],
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationTypeDef
  5. See KnowledgeBaseStatusType

KnowledgeBaseSummaryTypeDef#

# KnowledgeBaseSummaryTypeDef definition

class KnowledgeBaseSummaryTypeDef(TypedDict):
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    status: KnowledgeBaseStatusType,  # (5)
    description: NotRequired[str],
    renderingConfiguration: NotRequired[RenderingConfigurationTypeDef],  # (2)
    serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef],  # (3)
    sourceConfiguration: NotRequired[SourceConfigurationTypeDef],  # (4)
    tags: NotRequired[Dict[str, str]],
  1. See KnowledgeBaseTypeType
  2. See RenderingConfigurationTypeDef
  3. See ServerSideEncryptionConfigurationTypeDef
  4. See SourceConfigurationTypeDef
  5. See KnowledgeBaseStatusType

AssistantAssociationDataTypeDef#

# AssistantAssociationDataTypeDef definition

class AssistantAssociationDataTypeDef(TypedDict):
    assistantArn: str,
    assistantAssociationArn: str,
    assistantAssociationId: str,
    assistantId: str,
    associationData: AssistantAssociationOutputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See AssistantAssociationOutputDataTypeDef
  2. See AssociationTypeType

AssistantAssociationSummaryTypeDef#

# AssistantAssociationSummaryTypeDef definition

class AssistantAssociationSummaryTypeDef(TypedDict):
    assistantArn: str,
    assistantAssociationArn: str,
    assistantAssociationId: str,
    assistantId: str,
    associationData: AssistantAssociationOutputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    tags: NotRequired[Dict[str, str]],
  1. See AssistantAssociationOutputDataTypeDef
  2. See AssociationTypeType

CreateAssistantResponseTypeDef#

# CreateAssistantResponseTypeDef definition

class CreateAssistantResponseTypeDef(TypedDict):
    assistant: AssistantDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantDataTypeDef
  2. See ResponseMetadataTypeDef

GetAssistantResponseTypeDef#

# GetAssistantResponseTypeDef definition

class GetAssistantResponseTypeDef(TypedDict):
    assistant: AssistantDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantDataTypeDef
  2. See ResponseMetadataTypeDef

ListAssistantsResponseTypeDef#

# ListAssistantsResponseTypeDef definition

class ListAssistantsResponseTypeDef(TypedDict):
    assistantSummaries: List[AssistantSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantSummaryTypeDef
  2. See ResponseMetadataTypeDef

ExternalSourceConfigurationTypeDef#

# ExternalSourceConfigurationTypeDef definition

class ExternalSourceConfigurationTypeDef(TypedDict):
    configuration: ConfigurationTypeDef,  # (1)
    source: ExternalSourceType,  # (2)
  1. See ConfigurationTypeDef
  2. See ExternalSourceType

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    contentReference: ContentReferenceTypeDef,  # (1)
    excerpt: NotRequired[DocumentTextTypeDef],  # (2)
    title: NotRequired[DocumentTextTypeDef],  # (2)
  1. See ContentReferenceTypeDef
  2. See DocumentTextTypeDef
  3. See DocumentTextTypeDef

SearchContentRequestRequestTypeDef#

# SearchContentRequestRequestTypeDef definition

class SearchContentRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchExpressionTypeDef

SearchContentRequestSearchContentPaginateTypeDef#

# SearchContentRequestSearchContentPaginateTypeDef definition

class SearchContentRequestSearchContentPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

SearchSessionsRequestRequestTypeDef#

# SearchSessionsRequestRequestTypeDef definition

class SearchSessionsRequestRequestTypeDef(TypedDict):
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See SearchExpressionTypeDef

SearchSessionsRequestSearchSessionsPaginateTypeDef#

# SearchSessionsRequestSearchSessionsPaginateTypeDef definition

class SearchSessionsRequestSearchSessionsPaginateTypeDef(TypedDict):
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

RecommendationTriggerTypeDef#

# RecommendationTriggerTypeDef definition

class RecommendationTriggerTypeDef(TypedDict):
    data: RecommendationTriggerDataTypeDef,  # (1)
    id: str,
    recommendationIds: List[str],
    source: RecommendationSourceTypeType,  # (2)
    type: RecommendationTriggerTypeType,  # (3)
  1. See RecommendationTriggerDataTypeDef
  2. See RecommendationSourceTypeType
  3. See RecommendationTriggerTypeType

QuickResponseDataTypeDef#

# QuickResponseDataTypeDef definition

class QuickResponseDataTypeDef(TypedDict):
    contentType: str,
    createdTime: datetime,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    name: str,
    quickResponseArn: str,
    quickResponseId: str,
    status: QuickResponseStatusType,  # (3)
    channels: NotRequired[List[str]],
    contents: NotRequired[QuickResponseContentsTypeDef],  # (1)
    description: NotRequired[str],
    groupingConfiguration: NotRequired[GroupingConfigurationTypeDef],  # (2)
    isActive: NotRequired[bool],
    language: NotRequired[str],
    lastModifiedBy: NotRequired[str],
    shortcutKey: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See QuickResponseContentsTypeDef
  2. See GroupingConfigurationTypeDef
  3. See QuickResponseStatusType

QuickResponseSearchResultDataPaginatorTypeDef#

# QuickResponseSearchResultDataPaginatorTypeDef definition

class QuickResponseSearchResultDataPaginatorTypeDef(TypedDict):
    contentType: str,
    contents: QuickResponseContentsTypeDef,  # (1)
    createdTime: datetime,
    isActive: bool,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    name: str,
    quickResponseArn: str,
    quickResponseId: str,
    status: QuickResponseStatusType,  # (3)
    attributesInterpolated: NotRequired[List[str]],
    attributesNotInterpolated: NotRequired[List[str]],
    channels: NotRequired[List[str]],
    description: NotRequired[str],
    groupingConfiguration: NotRequired[GroupingConfigurationPaginatorTypeDef],  # (2)
    language: NotRequired[str],
    lastModifiedBy: NotRequired[str],
    shortcutKey: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See QuickResponseContentsTypeDef
  2. See GroupingConfigurationPaginatorTypeDef
  3. See QuickResponseStatusType

QuickResponseSearchResultDataTypeDef#

# QuickResponseSearchResultDataTypeDef definition

class QuickResponseSearchResultDataTypeDef(TypedDict):
    contentType: str,
    contents: QuickResponseContentsTypeDef,  # (1)
    createdTime: datetime,
    isActive: bool,
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    name: str,
    quickResponseArn: str,
    quickResponseId: str,
    status: QuickResponseStatusType,  # (3)
    attributesInterpolated: NotRequired[List[str]],
    attributesNotInterpolated: NotRequired[List[str]],
    channels: NotRequired[List[str]],
    description: NotRequired[str],
    groupingConfiguration: NotRequired[GroupingConfigurationTypeDef],  # (2)
    language: NotRequired[str],
    lastModifiedBy: NotRequired[str],
    shortcutKey: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See QuickResponseContentsTypeDef
  2. See GroupingConfigurationTypeDef
  3. See QuickResponseStatusType

SearchQuickResponsesRequestRequestTypeDef#

# SearchQuickResponsesRequestRequestTypeDef definition

class SearchQuickResponsesRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: QuickResponseSearchExpressionTypeDef,  # (1)
    attributes: NotRequired[Mapping[str, str]],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See QuickResponseSearchExpressionTypeDef

SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef#

# SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef definition

class SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef(TypedDict):
    knowledgeBaseId: str,
    searchExpression: QuickResponseSearchExpressionTypeDef,  # (1)
    attributes: NotRequired[Mapping[str, str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QuickResponseSearchExpressionTypeDef
  2. See PaginatorConfigTypeDef

CreateSessionResponseTypeDef#

# CreateSessionResponseTypeDef definition

class CreateSessionResponseTypeDef(TypedDict):
    session: SessionDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionDataTypeDef
  2. See ResponseMetadataTypeDef

GetSessionResponseTypeDef#

# GetSessionResponseTypeDef definition

class GetSessionResponseTypeDef(TypedDict):
    session: SessionDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionDataTypeDef
  2. See ResponseMetadataTypeDef

ListKnowledgeBasesResponsePaginatorTypeDef#

# ListKnowledgeBasesResponsePaginatorTypeDef definition

class ListKnowledgeBasesResponsePaginatorTypeDef(TypedDict):
    knowledgeBaseSummaries: List[KnowledgeBaseSummaryPaginatorTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseSummaryPaginatorTypeDef
  2. See ResponseMetadataTypeDef

CreateKnowledgeBaseResponseTypeDef#

# CreateKnowledgeBaseResponseTypeDef definition

class CreateKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

GetKnowledgeBaseResponseTypeDef#

# GetKnowledgeBaseResponseTypeDef definition

class GetKnowledgeBaseResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateKnowledgeBaseTemplateUriResponseTypeDef#

# UpdateKnowledgeBaseTemplateUriResponseTypeDef definition

class UpdateKnowledgeBaseTemplateUriResponseTypeDef(TypedDict):
    knowledgeBase: KnowledgeBaseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseDataTypeDef
  2. See ResponseMetadataTypeDef

ListKnowledgeBasesResponseTypeDef#

# ListKnowledgeBasesResponseTypeDef definition

class ListKnowledgeBasesResponseTypeDef(TypedDict):
    knowledgeBaseSummaries: List[KnowledgeBaseSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KnowledgeBaseSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateAssistantAssociationResponseTypeDef#

# CreateAssistantAssociationResponseTypeDef definition

class CreateAssistantAssociationResponseTypeDef(TypedDict):
    assistantAssociation: AssistantAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

GetAssistantAssociationResponseTypeDef#

# GetAssistantAssociationResponseTypeDef definition

class GetAssistantAssociationResponseTypeDef(TypedDict):
    assistantAssociation: AssistantAssociationDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationDataTypeDef
  2. See ResponseMetadataTypeDef

ListAssistantAssociationsResponseTypeDef#

# ListAssistantAssociationsResponseTypeDef definition

class ListAssistantAssociationsResponseTypeDef(TypedDict):
    assistantAssociationSummaries: List[AssistantAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssistantAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

ImportJobDataTypeDef#

# ImportJobDataTypeDef definition

class ImportJobDataTypeDef(TypedDict):
    createdTime: datetime,
    importJobId: str,
    importJobType: ImportJobTypeType,  # (2)
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    status: ImportJobStatusType,  # (3)
    uploadId: str,
    url: str,
    urlExpiry: datetime,
    externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef],  # (1)
    failedRecordReport: NotRequired[str],
    metadata: NotRequired[Dict[str, str]],
  1. See ExternalSourceConfigurationTypeDef
  2. See ImportJobTypeType
  3. See ImportJobStatusType

ImportJobSummaryTypeDef#

# ImportJobSummaryTypeDef definition

class ImportJobSummaryTypeDef(TypedDict):
    createdTime: datetime,
    importJobId: str,
    importJobType: ImportJobTypeType,  # (2)
    knowledgeBaseArn: str,
    knowledgeBaseId: str,
    lastModifiedTime: datetime,
    status: ImportJobStatusType,  # (3)
    uploadId: str,
    externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef],  # (1)
    metadata: NotRequired[Dict[str, str]],
  1. See ExternalSourceConfigurationTypeDef
  2. See ImportJobTypeType
  3. See ImportJobStatusType

StartImportJobRequestRequestTypeDef#

# StartImportJobRequestRequestTypeDef definition

class StartImportJobRequestRequestTypeDef(TypedDict):
    importJobType: ImportJobTypeType,  # (1)
    knowledgeBaseId: str,
    uploadId: str,
    clientToken: NotRequired[str],
    externalSourceConfiguration: NotRequired[ExternalSourceConfigurationTypeDef],  # (2)
    metadata: NotRequired[Mapping[str, str]],
  1. See ImportJobTypeType
  2. See ExternalSourceConfigurationTypeDef

RecommendationDataTypeDef#

# RecommendationDataTypeDef definition

class RecommendationDataTypeDef(TypedDict):
    document: DocumentTypeDef,  # (1)
    recommendationId: str,
    relevanceLevel: NotRequired[RelevanceLevelType],  # (2)
    relevanceScore: NotRequired[float],
    type: NotRequired[RecommendationTypeType],  # (3)
  1. See DocumentTypeDef
  2. See RelevanceLevelType
  3. See RecommendationTypeType

ResultDataTypeDef#

# ResultDataTypeDef definition

class ResultDataTypeDef(TypedDict):
    document: DocumentTypeDef,  # (1)
    resultId: str,
    relevanceScore: NotRequired[float],
  1. See DocumentTypeDef

CreateQuickResponseResponseTypeDef#

# CreateQuickResponseResponseTypeDef definition

class CreateQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

GetQuickResponseResponseTypeDef#

# GetQuickResponseResponseTypeDef definition

class GetQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

UpdateQuickResponseResponseTypeDef#

# UpdateQuickResponseResponseTypeDef definition

class UpdateQuickResponseResponseTypeDef(TypedDict):
    quickResponse: QuickResponseDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseDataTypeDef
  2. See ResponseMetadataTypeDef

SearchQuickResponsesResponsePaginatorTypeDef#

# SearchQuickResponsesResponsePaginatorTypeDef definition

class SearchQuickResponsesResponsePaginatorTypeDef(TypedDict):
    nextToken: str,
    results: List[QuickResponseSearchResultDataPaginatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseSearchResultDataPaginatorTypeDef
  2. See ResponseMetadataTypeDef

SearchQuickResponsesResponseTypeDef#

# SearchQuickResponsesResponseTypeDef definition

class SearchQuickResponsesResponseTypeDef(TypedDict):
    nextToken: str,
    results: List[QuickResponseSearchResultDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QuickResponseSearchResultDataTypeDef
  2. See ResponseMetadataTypeDef

GetImportJobResponseTypeDef#

# GetImportJobResponseTypeDef definition

class GetImportJobResponseTypeDef(TypedDict):
    importJob: ImportJobDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobDataTypeDef
  2. See ResponseMetadataTypeDef

StartImportJobResponseTypeDef#

# StartImportJobResponseTypeDef definition

class StartImportJobResponseTypeDef(TypedDict):
    importJob: ImportJobDataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobDataTypeDef
  2. See ResponseMetadataTypeDef

ListImportJobsResponseTypeDef#

# ListImportJobsResponseTypeDef definition

class ListImportJobsResponseTypeDef(TypedDict):
    importJobSummaries: List[ImportJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetRecommendationsResponseTypeDef#

# GetRecommendationsResponseTypeDef definition

class GetRecommendationsResponseTypeDef(TypedDict):
    recommendations: List[RecommendationDataTypeDef],  # (1)
    triggers: List[RecommendationTriggerTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See RecommendationDataTypeDef
  2. See RecommendationTriggerTypeDef
  3. See ResponseMetadataTypeDef

QueryAssistantResponseTypeDef#

# QueryAssistantResponseTypeDef definition

class QueryAssistantResponseTypeDef(TypedDict):
    nextToken: str,
    results: List[ResultDataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResultDataTypeDef
  2. See ResponseMetadataTypeDef