Typed dictionaries
Index > ConnectWisdomService > Typed dictionaries
Auto-generated documentation for ConnectWisdomService type annotations stubs module mypy-boto3-wisdom.
AppIntegrationsConfigurationTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AppIntegrationsConfigurationTypeDef
def get_value() -> AppIntegrationsConfigurationTypeDef:
return {
"appIntegrationArn": ...,
"objectFields": ...,
}
Definition
class AppIntegrationsConfigurationTypeDef(TypedDict):
appIntegrationArn: str,
objectFields: Sequence[str],
AssistantAssociationInputDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantAssociationInputDataTypeDef
def get_value() -> AssistantAssociationInputDataTypeDef:
return {
"knowledgeBaseId": ...,
}
KnowledgeBaseAssociationDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import KnowledgeBaseAssociationDataTypeDef
def get_value() -> KnowledgeBaseAssociationDataTypeDef:
return {
"knowledgeBaseArn": ...,
}
Definition
class KnowledgeBaseAssociationDataTypeDef(TypedDict):
knowledgeBaseArn: NotRequired[str],
knowledgeBaseId: NotRequired[str],
ServerSideEncryptionConfigurationTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ServerSideEncryptionConfigurationTypeDef
def get_value() -> ServerSideEncryptionConfigurationTypeDef:
return {
"kmsKeyId": ...,
}
ContentDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ContentDataTypeDef
def get_value() -> ContentDataTypeDef:
return {
"contentArn": ...,
"contentId": ...,
"contentType": ...,
"knowledgeBaseArn": ...,
"knowledgeBaseId": ...,
"metadata": ...,
"name": ...,
"revisionId": ...,
"status": ...,
"title": ...,
"url": ...,
"urlExpiry": ...,
}
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]],
ContentReferenceTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ContentReferenceTypeDef
def get_value() -> ContentReferenceTypeDef:
return {
"contentArn": ...,
}
Definition
class ContentReferenceTypeDef(TypedDict):
contentArn: NotRequired[str],
contentId: NotRequired[str],
knowledgeBaseArn: NotRequired[str],
knowledgeBaseId: NotRequired[str],
ContentSummaryTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ContentSummaryTypeDef
def get_value() -> ContentSummaryTypeDef:
return {
"contentArn": ...,
"contentId": ...,
"contentType": ...,
"knowledgeBaseArn": ...,
"knowledgeBaseId": ...,
"metadata": ...,
"name": ...,
"revisionId": ...,
"status": ...,
"title": ...,
}
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]],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateContentRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateContentRequestRequestTypeDef
def get_value() -> CreateContentRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
"name": ...,
"uploadId": ...,
}
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
Usage Example
from mypy_boto3_wisdom.type_defs import RenderingConfigurationTypeDef
def get_value() -> RenderingConfigurationTypeDef:
return {
"templateUri": ...,
}
CreateSessionRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateSessionRequestRequestTypeDef
def get_value() -> CreateSessionRequestRequestTypeDef:
return {
"assistantId": ...,
"name": ...,
}
Definition
class CreateSessionRequestRequestTypeDef(TypedDict):
assistantId: str,
name: str,
clientToken: NotRequired[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
SessionDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SessionDataTypeDef
def get_value() -> SessionDataTypeDef:
return {
"name": ...,
"sessionArn": ...,
"sessionId": ...,
}
Definition
class SessionDataTypeDef(TypedDict):
name: str,
sessionArn: str,
sessionId: str,
description: NotRequired[str],
tags: NotRequired[Dict[str, str]],
DeleteAssistantAssociationRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DeleteAssistantAssociationRequestRequestTypeDef
def get_value() -> DeleteAssistantAssociationRequestRequestTypeDef:
return {
"assistantAssociationId": ...,
"assistantId": ...,
}
Definition
class DeleteAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,
DeleteAssistantRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DeleteAssistantRequestRequestTypeDef
def get_value() -> DeleteAssistantRequestRequestTypeDef:
return {
"assistantId": ...,
}
DeleteContentRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DeleteContentRequestRequestTypeDef
def get_value() -> DeleteContentRequestRequestTypeDef:
return {
"contentId": ...,
"knowledgeBaseId": ...,
}
Definition
class DeleteContentRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
DeleteKnowledgeBaseRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DeleteKnowledgeBaseRequestRequestTypeDef
def get_value() -> DeleteKnowledgeBaseRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
}
HighlightTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import HighlightTypeDef
def get_value() -> HighlightTypeDef:
return {
"beginOffsetInclusive": ...,
}
Definition
class HighlightTypeDef(TypedDict):
beginOffsetInclusive: NotRequired[int],
endOffsetExclusive: NotRequired[int],
FilterTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"field": ...,
"operator": ...,
"value": ...,
}
Definition
class FilterTypeDef(TypedDict):
field: FilterFieldType, # (1)
operator: FilterOperatorType, # (2)
value: str,
- See FilterFieldType
- See FilterOperatorType
GetAssistantAssociationRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetAssistantAssociationRequestRequestTypeDef
def get_value() -> GetAssistantAssociationRequestRequestTypeDef:
return {
"assistantAssociationId": ...,
"assistantId": ...,
}
Definition
class GetAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantAssociationId: str,
assistantId: str,
GetAssistantRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetAssistantRequestRequestTypeDef
def get_value() -> GetAssistantRequestRequestTypeDef:
return {
"assistantId": ...,
}
GetContentRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetContentRequestRequestTypeDef
def get_value() -> GetContentRequestRequestTypeDef:
return {
"contentId": ...,
"knowledgeBaseId": ...,
}
GetContentSummaryRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetContentSummaryRequestRequestTypeDef
def get_value() -> GetContentSummaryRequestRequestTypeDef:
return {
"contentId": ...,
"knowledgeBaseId": ...,
}
Definition
class GetContentSummaryRequestRequestTypeDef(TypedDict):
contentId: str,
knowledgeBaseId: str,
GetKnowledgeBaseRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetKnowledgeBaseRequestRequestTypeDef
def get_value() -> GetKnowledgeBaseRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
}
GetRecommendationsRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetRecommendationsRequestRequestTypeDef
def get_value() -> GetRecommendationsRequestRequestTypeDef:
return {
"assistantId": ...,
"sessionId": ...,
}
Definition
class GetRecommendationsRequestRequestTypeDef(TypedDict):
assistantId: str,
sessionId: str,
maxResults: NotRequired[int],
waitTimeSeconds: NotRequired[int],
GetSessionRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetSessionRequestRequestTypeDef
def get_value() -> GetSessionRequestRequestTypeDef:
return {
"assistantId": ...,
"sessionId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAssistantAssociationsRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantAssociationsRequestRequestTypeDef
def get_value() -> ListAssistantAssociationsRequestRequestTypeDef:
return {
"assistantId": ...,
}
Definition
class ListAssistantAssociationsRequestRequestTypeDef(TypedDict):
assistantId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAssistantsRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantsRequestRequestTypeDef
def get_value() -> ListAssistantsRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListAssistantsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListContentsRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListContentsRequestRequestTypeDef
def get_value() -> ListContentsRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
}
Definition
class ListContentsRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListKnowledgeBasesRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListKnowledgeBasesRequestRequestTypeDef
def get_value() -> ListKnowledgeBasesRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
NotifyRecommendationsReceivedErrorTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import NotifyRecommendationsReceivedErrorTypeDef
def get_value() -> NotifyRecommendationsReceivedErrorTypeDef:
return {
"message": ...,
}
Definition
class NotifyRecommendationsReceivedErrorTypeDef(TypedDict):
message: NotRequired[str],
recommendationId: NotRequired[str],
NotifyRecommendationsReceivedRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import NotifyRecommendationsReceivedRequestRequestTypeDef
def get_value() -> NotifyRecommendationsReceivedRequestRequestTypeDef:
return {
"assistantId": ...,
"recommendationIds": ...,
"sessionId": ...,
}
Definition
class NotifyRecommendationsReceivedRequestRequestTypeDef(TypedDict):
assistantId: str,
recommendationIds: Sequence[str],
sessionId: str,
QueryAssistantRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import QueryAssistantRequestRequestTypeDef
def get_value() -> QueryAssistantRequestRequestTypeDef:
return {
"assistantId": ...,
"queryText": ...,
}
Definition
class QueryAssistantRequestRequestTypeDef(TypedDict):
assistantId: str,
queryText: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
QueryRecommendationTriggerDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import QueryRecommendationTriggerDataTypeDef
def get_value() -> QueryRecommendationTriggerDataTypeDef:
return {
"text": ...,
}
RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef
def get_value() -> RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
}
Definition
class RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
SessionSummaryTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SessionSummaryTypeDef
def get_value() -> SessionSummaryTypeDef:
return {
"assistantArn": ...,
"assistantId": ...,
"sessionArn": ...,
"sessionId": ...,
}
Definition
class SessionSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
sessionArn: str,
sessionId: str,
StartContentUploadRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import StartContentUploadRequestRequestTypeDef
def get_value() -> StartContentUploadRequestRequestTypeDef:
return {
"contentType": ...,
"knowledgeBaseId": ...,
}
Definition
class StartContentUploadRequestRequestTypeDef(TypedDict):
contentType: str,
knowledgeBaseId: str,
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateContentRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import UpdateContentRequestRequestTypeDef
def get_value() -> UpdateContentRequestRequestTypeDef:
return {
"contentId": ...,
"knowledgeBaseId": ...,
}
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
Usage Example
from mypy_boto3_wisdom.type_defs import UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef
def get_value() -> UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
"templateUri": ...,
}
Definition
class UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
templateUri: str,
SourceConfigurationTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SourceConfigurationTypeDef
def get_value() -> SourceConfigurationTypeDef:
return {
"appIntegrations": ...,
}
Definition
class SourceConfigurationTypeDef(TypedDict):
appIntegrations: NotRequired[AppIntegrationsConfigurationTypeDef], # (1)
CreateAssistantAssociationRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateAssistantAssociationRequestRequestTypeDef
def get_value() -> CreateAssistantAssociationRequestRequestTypeDef:
return {
"assistantId": ...,
"association": ...,
"associationType": ...,
}
Definition
class CreateAssistantAssociationRequestRequestTypeDef(TypedDict):
assistantId: str,
association: AssistantAssociationInputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
AssistantAssociationOutputDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantAssociationOutputDataTypeDef
def get_value() -> AssistantAssociationOutputDataTypeDef:
return {
"knowledgeBaseAssociation": ...,
}
Definition
class AssistantAssociationOutputDataTypeDef(TypedDict):
knowledgeBaseAssociation: NotRequired[KnowledgeBaseAssociationDataTypeDef], # (1)
AssistantDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantDataTypeDef
def get_value() -> AssistantDataTypeDef:
return {
"assistantArn": ...,
"assistantId": ...,
"name": ...,
"status": ...,
"type": ...,
}
Definition
class AssistantDataTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
name: str,
status: AssistantStatusType, # (2)
type: AssistantTypeType, # (3)
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (1)
tags: NotRequired[Dict[str, str]],
AssistantSummaryTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantSummaryTypeDef
def get_value() -> AssistantSummaryTypeDef:
return {
"assistantArn": ...,
"assistantId": ...,
"name": ...,
"status": ...,
"type": ...,
}
Definition
class AssistantSummaryTypeDef(TypedDict):
assistantArn: str,
assistantId: str,
name: str,
status: AssistantStatusType, # (2)
type: AssistantTypeType, # (3)
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (1)
tags: NotRequired[Dict[str, str]],
CreateAssistantRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateAssistantRequestRequestTypeDef
def get_value() -> CreateAssistantRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
}
Definition
class CreateAssistantRequestRequestTypeDef(TypedDict):
name: str,
type: AssistantTypeType, # (1)
clientToken: NotRequired[str],
description: NotRequired[str],
serverSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
tags: NotRequired[Mapping[str, str]],
CreateContentResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateContentResponseTypeDef
def get_value() -> CreateContentResponseTypeDef:
return {
"content": ...,
"ResponseMetadata": ...,
}
Definition
class CreateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetContentResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetContentResponseTypeDef
def get_value() -> GetContentResponseTypeDef:
return {
"content": ...,
"ResponseMetadata": ...,
}
Definition
class GetContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetContentSummaryResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetContentSummaryResponseTypeDef
def get_value() -> GetContentSummaryResponseTypeDef:
return {
"contentSummary": ...,
"ResponseMetadata": ...,
}
Definition
class GetContentSummaryResponseTypeDef(TypedDict):
contentSummary: ContentSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListContentsResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListContentsResponseTypeDef
def get_value() -> ListContentsResponseTypeDef:
return {
"contentSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListContentsResponseTypeDef(TypedDict):
contentSummaries: List[ContentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SearchContentResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchContentResponseTypeDef
def get_value() -> SearchContentResponseTypeDef:
return {
"contentSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchContentResponseTypeDef(TypedDict):
contentSummaries: List[ContentSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartContentUploadResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import StartContentUploadResponseTypeDef
def get_value() -> StartContentUploadResponseTypeDef:
return {
"headersToInclude": ...,
"uploadId": ...,
"url": ...,
"urlExpiry": ...,
"ResponseMetadata": ...,
}
Definition
class StartContentUploadResponseTypeDef(TypedDict):
headersToInclude: Dict[str, str],
uploadId: str,
url: str,
urlExpiry: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateContentResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import UpdateContentResponseTypeDef
def get_value() -> UpdateContentResponseTypeDef:
return {
"content": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateContentResponseTypeDef(TypedDict):
content: ContentDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateSessionResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateSessionResponseTypeDef
def get_value() -> CreateSessionResponseTypeDef:
return {
"session": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSessionResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetSessionResponseTypeDef
def get_value() -> GetSessionResponseTypeDef:
return {
"session": ...,
"ResponseMetadata": ...,
}
Definition
class GetSessionResponseTypeDef(TypedDict):
session: SessionDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentTextTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DocumentTextTypeDef
def get_value() -> DocumentTextTypeDef:
return {
"highlights": ...,
}
Definition
class DocumentTextTypeDef(TypedDict):
highlights: NotRequired[List[HighlightTypeDef]], # (1)
text: NotRequired[str],
- See HighlightTypeDef
SearchExpressionTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchExpressionTypeDef
def get_value() -> SearchExpressionTypeDef:
return {
"filters": ...,
}
- See FilterTypeDef
ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef
def get_value() -> ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef:
return {
"assistantId": ...,
}
Definition
class ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef(TypedDict):
assistantId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAssistantsRequestListAssistantsPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantsRequestListAssistantsPaginateTypeDef
def get_value() -> ListAssistantsRequestListAssistantsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListAssistantsRequestListAssistantsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListContentsRequestListContentsPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListContentsRequestListContentsPaginateTypeDef
def get_value() -> ListContentsRequestListContentsPaginateTypeDef:
return {
"knowledgeBaseId": ...,
}
Definition
class ListContentsRequestListContentsPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef
def get_value() -> ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryAssistantRequestQueryAssistantPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import QueryAssistantRequestQueryAssistantPaginateTypeDef
def get_value() -> QueryAssistantRequestQueryAssistantPaginateTypeDef:
return {
"assistantId": ...,
"queryText": ...,
}
Definition
class QueryAssistantRequestQueryAssistantPaginateTypeDef(TypedDict):
assistantId: str,
queryText: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
NotifyRecommendationsReceivedResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import NotifyRecommendationsReceivedResponseTypeDef
def get_value() -> NotifyRecommendationsReceivedResponseTypeDef:
return {
"errors": ...,
"recommendationIds": ...,
"ResponseMetadata": ...,
}
Definition
class NotifyRecommendationsReceivedResponseTypeDef(TypedDict):
errors: List[NotifyRecommendationsReceivedErrorTypeDef], # (1)
recommendationIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecommendationTriggerDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import RecommendationTriggerDataTypeDef
def get_value() -> RecommendationTriggerDataTypeDef:
return {
"query": ...,
}
Definition
class RecommendationTriggerDataTypeDef(TypedDict):
query: NotRequired[QueryRecommendationTriggerDataTypeDef], # (1)
SearchSessionsResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchSessionsResponseTypeDef
def get_value() -> SearchSessionsResponseTypeDef:
return {
"nextToken": ...,
"sessionSummaries": ...,
"ResponseMetadata": ...,
}
Definition
class SearchSessionsResponseTypeDef(TypedDict):
nextToken: str,
sessionSummaries: List[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateKnowledgeBaseRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateKnowledgeBaseRequestRequestTypeDef
def get_value() -> CreateKnowledgeBaseRequestRequestTypeDef:
return {
"knowledgeBaseType": ...,
"name": ...,
}
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]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationTypeDef
KnowledgeBaseDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import KnowledgeBaseDataTypeDef
def get_value() -> KnowledgeBaseDataTypeDef:
return {
"knowledgeBaseArn": ...,
"knowledgeBaseId": ...,
"knowledgeBaseType": ...,
"name": ...,
"status": ...,
}
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]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationTypeDef
- See KnowledgeBaseStatusType
KnowledgeBaseSummaryTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import KnowledgeBaseSummaryTypeDef
def get_value() -> KnowledgeBaseSummaryTypeDef:
return {
"knowledgeBaseArn": ...,
"knowledgeBaseId": ...,
"knowledgeBaseType": ...,
"name": ...,
"status": ...,
}
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]],
- See KnowledgeBaseTypeType
- See RenderingConfigurationTypeDef
- See ServerSideEncryptionConfigurationTypeDef
- See SourceConfigurationTypeDef
- See KnowledgeBaseStatusType
AssistantAssociationDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantAssociationDataTypeDef
def get_value() -> AssistantAssociationDataTypeDef:
return {
"assistantArn": ...,
"assistantAssociationArn": ...,
"assistantAssociationId": ...,
"assistantId": ...,
"associationData": ...,
"associationType": ...,
}
Definition
class AssistantAssociationDataTypeDef(TypedDict):
assistantArn: str,
assistantAssociationArn: str,
assistantAssociationId: str,
assistantId: str,
associationData: AssistantAssociationOutputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
tags: NotRequired[Dict[str, str]],
AssistantAssociationSummaryTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import AssistantAssociationSummaryTypeDef
def get_value() -> AssistantAssociationSummaryTypeDef:
return {
"assistantArn": ...,
"assistantAssociationArn": ...,
"assistantAssociationId": ...,
"assistantId": ...,
"associationData": ...,
"associationType": ...,
}
Definition
class AssistantAssociationSummaryTypeDef(TypedDict):
assistantArn: str,
assistantAssociationArn: str,
assistantAssociationId: str,
assistantId: str,
associationData: AssistantAssociationOutputDataTypeDef, # (1)
associationType: AssociationTypeType, # (2)
tags: NotRequired[Dict[str, str]],
CreateAssistantResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateAssistantResponseTypeDef
def get_value() -> CreateAssistantResponseTypeDef:
return {
"assistant": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAssistantResponseTypeDef(TypedDict):
assistant: AssistantDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssistantResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetAssistantResponseTypeDef
def get_value() -> GetAssistantResponseTypeDef:
return {
"assistant": ...,
"ResponseMetadata": ...,
}
Definition
class GetAssistantResponseTypeDef(TypedDict):
assistant: AssistantDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssistantsResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantsResponseTypeDef
def get_value() -> ListAssistantsResponseTypeDef:
return {
"assistantSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAssistantsResponseTypeDef(TypedDict):
assistantSummaries: List[AssistantSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"contentReference": ...,
}
Definition
class DocumentTypeDef(TypedDict):
contentReference: ContentReferenceTypeDef, # (1)
excerpt: NotRequired[DocumentTextTypeDef], # (2)
title: NotRequired[DocumentTextTypeDef], # (2)
SearchContentRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchContentRequestRequestTypeDef
def get_value() -> SearchContentRequestRequestTypeDef:
return {
"knowledgeBaseId": ...,
"searchExpression": ...,
}
Definition
class SearchContentRequestRequestTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: SearchExpressionTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchContentRequestSearchContentPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchContentRequestSearchContentPaginateTypeDef
def get_value() -> SearchContentRequestSearchContentPaginateTypeDef:
return {
"knowledgeBaseId": ...,
"searchExpression": ...,
}
Definition
class SearchContentRequestSearchContentPaginateTypeDef(TypedDict):
knowledgeBaseId: str,
searchExpression: SearchExpressionTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchSessionsRequestRequestTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchSessionsRequestRequestTypeDef
def get_value() -> SearchSessionsRequestRequestTypeDef:
return {
"assistantId": ...,
"searchExpression": ...,
}
Definition
class SearchSessionsRequestRequestTypeDef(TypedDict):
assistantId: str,
searchExpression: SearchExpressionTypeDef, # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
SearchSessionsRequestSearchSessionsPaginateTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import SearchSessionsRequestSearchSessionsPaginateTypeDef
def get_value() -> SearchSessionsRequestSearchSessionsPaginateTypeDef:
return {
"assistantId": ...,
"searchExpression": ...,
}
Definition
class SearchSessionsRequestSearchSessionsPaginateTypeDef(TypedDict):
assistantId: str,
searchExpression: SearchExpressionTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
RecommendationTriggerTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import RecommendationTriggerTypeDef
def get_value() -> RecommendationTriggerTypeDef:
return {
"data": ...,
"id": ...,
"recommendationIds": ...,
"source": ...,
"type": ...,
}
Definition
class RecommendationTriggerTypeDef(TypedDict):
data: RecommendationTriggerDataTypeDef, # (1)
id: str,
recommendationIds: List[str],
source: RecommendationSourceTypeType, # (2)
type: RecommendationTriggerTypeType, # (3)
- See RecommendationTriggerDataTypeDef
- See RecommendationSourceTypeType
- See RecommendationTriggerTypeType
CreateKnowledgeBaseResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateKnowledgeBaseResponseTypeDef
def get_value() -> CreateKnowledgeBaseResponseTypeDef:
return {
"knowledgeBase": ...,
"ResponseMetadata": ...,
}
Definition
class CreateKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetKnowledgeBaseResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetKnowledgeBaseResponseTypeDef
def get_value() -> GetKnowledgeBaseResponseTypeDef:
return {
"knowledgeBase": ...,
"ResponseMetadata": ...,
}
Definition
class GetKnowledgeBaseResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateKnowledgeBaseTemplateUriResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import UpdateKnowledgeBaseTemplateUriResponseTypeDef
def get_value() -> UpdateKnowledgeBaseTemplateUriResponseTypeDef:
return {
"knowledgeBase": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateKnowledgeBaseTemplateUriResponseTypeDef(TypedDict):
knowledgeBase: KnowledgeBaseDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKnowledgeBasesResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListKnowledgeBasesResponseTypeDef
def get_value() -> ListKnowledgeBasesResponseTypeDef:
return {
"knowledgeBaseSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListKnowledgeBasesResponseTypeDef(TypedDict):
knowledgeBaseSummaries: List[KnowledgeBaseSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAssistantAssociationResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import CreateAssistantAssociationResponseTypeDef
def get_value() -> CreateAssistantAssociationResponseTypeDef:
return {
"assistantAssociation": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAssistantAssociationResponseTypeDef(TypedDict):
assistantAssociation: AssistantAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssistantAssociationResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetAssistantAssociationResponseTypeDef
def get_value() -> GetAssistantAssociationResponseTypeDef:
return {
"assistantAssociation": ...,
"ResponseMetadata": ...,
}
Definition
class GetAssistantAssociationResponseTypeDef(TypedDict):
assistantAssociation: AssistantAssociationDataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssistantAssociationsResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ListAssistantAssociationsResponseTypeDef
def get_value() -> ListAssistantAssociationsResponseTypeDef:
return {
"assistantAssociationSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAssistantAssociationsResponseTypeDef(TypedDict):
assistantAssociationSummaries: List[AssistantAssociationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RecommendationDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import RecommendationDataTypeDef
def get_value() -> RecommendationDataTypeDef:
return {
"document": ...,
"recommendationId": ...,
}
Definition
class RecommendationDataTypeDef(TypedDict):
document: DocumentTypeDef, # (1)
recommendationId: str,
relevanceLevel: NotRequired[RelevanceLevelType], # (2)
relevanceScore: NotRequired[float],
type: NotRequired[RecommendationTypeType], # (3)
- See DocumentTypeDef
- See RelevanceLevelType
- See RecommendationTypeType
ResultDataTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import ResultDataTypeDef
def get_value() -> ResultDataTypeDef:
return {
"document": ...,
"resultId": ...,
}
Definition
class ResultDataTypeDef(TypedDict):
document: DocumentTypeDef, # (1)
resultId: str,
relevanceScore: NotRequired[float],
- See DocumentTypeDef
GetRecommendationsResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import GetRecommendationsResponseTypeDef
def get_value() -> GetRecommendationsResponseTypeDef:
return {
"recommendations": ...,
"triggers": ...,
"ResponseMetadata": ...,
}
Definition
class GetRecommendationsResponseTypeDef(TypedDict):
recommendations: List[RecommendationDataTypeDef], # (1)
triggers: List[RecommendationTriggerTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
QueryAssistantResponseTypeDef
Usage Example
from mypy_boto3_wisdom.type_defs import QueryAssistantResponseTypeDef
def get_value() -> QueryAssistantResponseTypeDef:
return {
"nextToken": ...,
"results": ...,
"ResponseMetadata": ...,
}