Skip to content

Wisdom Classes

AppIntegrationsConfigurationPaginatorTypeDef

appIntegrationArn

  • Type:
  • Required: Yes

objectFields

  • Type: typing.Optional[typing.List[str]]

AppIntegrationsConfigurationTypeDef

appIntegrationArn

  • Type:
  • Required: Yes

objectFields

  • Type: typing.Optional[typing.Sequence[str]]

AssistantAssociationDataTypeDef

assistantArn

  • Type:
  • Required: Yes

assistantAssociationArn

  • Type:
  • Required: Yes

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

associationData

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantAssociationInputDataTypeDef

knowledgeBaseId

  • Type: typing.Optional[str]

AssistantAssociationOutputDataTypeDef

knowledgeBaseAssociation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.KnowledgeBaseAssociationDataTypeDef]

AssistantAssociationSummaryTypeDef

assistantArn

  • Type:
  • Required: Yes

assistantAssociationArn

  • Type:
  • Required: Yes

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

associationData

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantDataTypeDef

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.AssistantIntegrationConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssistantIntegrationConfigurationTypeDef

topicIntegrationArn

  • Type: typing.Optional[str]

AssistantSummaryTypeDef

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.AssistantIntegrationConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ConfigurationTypeDef

connectConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ConnectConfigurationTypeDef]

ConnectConfigurationTypeDef

instanceId

  • Type: typing.Optional[str]

ContentDataTypeDef

contentArn

  • Type:
  • Required: Yes

contentId

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Dict[str, str]
  • Required: Yes

name

  • Type:
  • Required: Yes

revisionId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED']
  • Required: Yes

title

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

linkOutUri

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ContentReferenceTypeDef

contentArn

  • Type: typing.Optional[str]

contentId

  • Type: typing.Optional[str]

knowledgeBaseArn

  • Type: typing.Optional[str]

knowledgeBaseId

  • Type: typing.Optional[str]

ContentSummaryTypeDef

contentArn

  • Type:
  • Required: Yes

contentId

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Dict[str, str]
  • Required: Yes

name

  • Type:
  • Required: Yes

revisionId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED']
  • Required: Yes

title

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssistantAssociationRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

association

  • Type:
  • Required: Yes

associationType

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateAssistantAssociationResponseTypeDef

assistantAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssistantRequestRequestTypeDef

name

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['AGENT']
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateAssistantResponseTypeDef

assistant

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateContentRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

metadata

  • Type: typing.Optional[typing.Mapping[str, str]]

overrideLinkOutUri

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

title

  • Type: typing.Optional[str]

CreateContentResponseTypeDef

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateKnowledgeBaseRequestRequestTypeDef

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.RenderingConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.SourceConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateKnowledgeBaseResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateQuickResponseRequestRequestTypeDef

content

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

channels

  • Type: typing.Optional[typing.Sequence[str]]

clientToken

  • Type: typing.Optional[str]

contentType

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.GroupingConfigurationTypeDef]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateQuickResponseResponseTypeDef

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateSessionRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateSessionResponseTypeDef

session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAssistantAssociationRequestRequestTypeDef

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

DeleteAssistantRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

DeleteContentRequestRequestTypeDef

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteImportJobRequestRequestTypeDef

importJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteKnowledgeBaseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

DeleteQuickResponseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

DocumentTextTypeDef

highlights

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.wisdom_classes.HighlightTypeDef]]

text

  • Type: typing.Optional[str]

DocumentTypeDef

contentReference

  • Type:
  • Required: Yes

excerpt

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.DocumentTextTypeDef]

title

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.DocumentTextTypeDef]

ExternalSourceConfigurationTypeDef

configuration

  • Type:
  • Required: Yes

source

  • Type: typing.Literal['AMAZON_CONNECT']
  • Required: Yes

FilterTypeDef

field

  • Type: typing.Literal['NAME']
  • Required: Yes

operator

  • Type: typing.Literal['EQUALS']
  • Required: Yes

value

  • Type:
  • Required: Yes

GetAssistantAssociationRequestRequestTypeDef

assistantAssociationId

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

GetAssistantAssociationResponseTypeDef

assistantAssociation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAssistantRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

GetAssistantResponseTypeDef

assistant

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetContentRequestRequestTypeDef

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetContentResponseTypeDef

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetContentSummaryRequestRequestTypeDef

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetContentSummaryResponseTypeDef

contentSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetImportJobRequestRequestTypeDef

importJobId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

GetImportJobResponseTypeDef

importJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetKnowledgeBaseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

GetKnowledgeBaseResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQuickResponseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

GetQuickResponseResponseTypeDef

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRecommendationsRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

waitTimeSeconds

  • Type: typing.Optional[int]

GetRecommendationsResponseTypeDef

recommendations

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.RecommendationDataTypeDef]
  • Required: Yes

triggers

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.RecommendationTriggerTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSessionRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetSessionResponseTypeDef

session

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GroupingConfigurationPaginatorTypeDef

criteria

  • Type: typing.Optional[str]

values

  • Type: typing.Optional[typing.List[str]]

GroupingConfigurationTypeDef

criteria

  • Type: typing.Optional[str]

values

  • Type: typing.Optional[typing.Sequence[str]]

HighlightTypeDef

beginOffsetInclusive

  • Type: typing.Optional[int]

endOffsetExclusive

  • Type: typing.Optional[int]

ImportJobDataTypeDef

createdTime

  • Type:
  • Required: Yes

importJobId

  • Type:
  • Required: Yes

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'FAILED', 'START_IN_PROGRESS']
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ExternalSourceConfigurationTypeDef]

failedRecordReport

  • Type: typing.Optional[str]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

ImportJobSummaryTypeDef

createdTime

  • Type:
  • Required: Yes

importJobId

  • Type:
  • Required: Yes

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['COMPLETE', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'FAILED', 'START_IN_PROGRESS']
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ExternalSourceConfigurationTypeDef]

metadata

  • Type: typing.Optional[typing.Dict[str, str]]

KnowledgeBaseAssociationDataTypeDef

knowledgeBaseArn

  • Type: typing.Optional[str]

knowledgeBaseId

  • Type: typing.Optional[str]

KnowledgeBaseDataTypeDef

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

description

  • Type: typing.Optional[str]

lastContentModificationTime

  • Type: typing.Optional[datetime.datetime]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.RenderingConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.SourceConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

KnowledgeBaseSummaryPaginatorTypeDef

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

description

  • Type: typing.Optional[str]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.RenderingConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.SourceConfigurationPaginatorTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

KnowledgeBaseSummaryTypeDef

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

knowledgeBaseType

  • Type: typing.Literal['CUSTOM', 'EXTERNAL', 'QUICK_RESPONSES']
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']
  • Required: Yes

description

  • Type: typing.Optional[str]

renderingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.RenderingConfigurationTypeDef]

serverSideEncryptionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ServerSideEncryptionConfigurationTypeDef]

sourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.SourceConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

ListAssistantAssociationsRequestListAssistantAssociationsPaginateTypeDef

assistantId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListAssistantAssociationsRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAssistantAssociationsResponseTypeDef

assistantAssociationSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.AssistantAssociationSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAssistantsRequestListAssistantsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListAssistantsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAssistantsResponseTypeDef

assistantSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.AssistantSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListContentsRequestListContentsPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListContentsRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListContentsResponseTypeDef

contentSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.ContentSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListImportJobsRequestListImportJobsPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListImportJobsRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListImportJobsResponseTypeDef

importJobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.ImportJobSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListKnowledgeBasesRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListKnowledgeBasesResponsePaginatorTypeDef

knowledgeBaseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.KnowledgeBaseSummaryPaginatorTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListKnowledgeBasesResponseTypeDef

knowledgeBaseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.KnowledgeBaseSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListQuickResponsesRequestListQuickResponsesPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

ListQuickResponsesRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListQuickResponsesResponseTypeDef

nextToken

  • Type:
  • Required: Yes

quickResponseSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NotifyRecommendationsReceivedErrorTypeDef

message

  • Type: typing.Optional[str]

recommendationId

  • Type: typing.Optional[str]

NotifyRecommendationsReceivedRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

recommendationIds

  • Type: typing.Sequence[str]
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

NotifyRecommendationsReceivedResponseTypeDef

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.NotifyRecommendationsReceivedErrorTypeDef]
  • Required: Yes

recommendationIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

QueryAssistantRequestQueryAssistantPaginateTypeDef

assistantId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

QueryAssistantRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

queryText

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

QueryAssistantResponseTypeDef

nextToken

  • Type:
  • Required: Yes

results

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.ResultDataTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

QueryRecommendationTriggerDataTypeDef

text

  • Type: typing.Optional[str]

QuickResponseContentProviderTypeDef

content

  • Type: typing.Optional[str]

QuickResponseContentsTypeDef

markdown

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseContentProviderTypeDef]

plainText

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseContentProviderTypeDef]

QuickResponseDataProviderTypeDef

content

  • Type: typing.Optional[str]

QuickResponseDataTypeDef

contentType

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

contents

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseContentsTypeDef]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.GroupingConfigurationTypeDef]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

lastModifiedBy

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

QuickResponseFilterFieldTypeDef

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['EQUALS', 'PREFIX']
  • Required: Yes

includeNoExistence

  • Type: typing.Optional[bool]

values

  • Type: typing.Optional[typing.Sequence[str]]

QuickResponseOrderFieldTypeDef

name

  • Type:
  • Required: Yes

order

  • Type: typing.Optional[typing.Literal['ASC', 'DESC']]

QuickResponseQueryFieldTypeDef

name

  • Type:
  • Required: Yes

operator

  • Type: typing.Literal['CONTAINS', 'CONTAINS_AND_PREFIX']
  • Required: Yes

values

  • Type: typing.Sequence[str]
  • Required: Yes

allowFuzziness

  • Type: typing.Optional[bool]

priority

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]

QuickResponseSearchExpressionTypeDef

filters

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseFilterFieldTypeDef]]

orderOnField

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseOrderFieldTypeDef]

queries

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseQueryFieldTypeDef]]

QuickResponseSearchResultDataPaginatorTypeDef

contentType

  • Type:
  • Required: Yes

contents

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

isActive

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

attributesInterpolated

  • Type: typing.Optional[typing.List[str]]

attributesNotInterpolated

  • Type: typing.Optional[typing.List[str]]

channels

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.GroupingConfigurationPaginatorTypeDef]

language

  • Type: typing.Optional[str]

lastModifiedBy

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

QuickResponseSearchResultDataTypeDef

contentType

  • Type:
  • Required: Yes

contents

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

isActive

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

attributesInterpolated

  • Type: typing.Optional[typing.List[str]]

attributesNotInterpolated

  • Type: typing.Optional[typing.List[str]]

channels

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.GroupingConfigurationTypeDef]

language

  • Type: typing.Optional[str]

lastModifiedBy

  • Type: typing.Optional[str]

shortcutKey

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

QuickResponseSummaryTypeDef

contentType

  • Type:
  • Required: Yes

createdTime

  • Type:
  • Required: Yes

knowledgeBaseArn

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

lastModifiedTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

quickResponseArn

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CREATED', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

channels

  • Type: typing.Optional[typing.List[str]]

description

  • Type: typing.Optional[str]

isActive

  • Type: typing.Optional[bool]

lastModifiedBy

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

RecommendationDataTypeDef

document

  • Type:
  • Required: Yes

recommendationId

  • Type:
  • Required: Yes

relevanceLevel

  • Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]

relevanceScore

  • Type: typing.Optional[float]

type

  • Type: typing.Optional[typing.Literal['KNOWLEDGE_CONTENT']]

RecommendationTriggerDataTypeDef

query

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QueryRecommendationTriggerDataTypeDef]

RecommendationTriggerTypeDef

data

  • Type:
  • Required: Yes

id

  • Type:
  • Required: Yes

recommendationIds

  • Type: typing.List[str]
  • Required: Yes

source

  • Type: typing.Literal['ISSUE_DETECTION', 'OTHER', 'RULE_EVALUATION']
  • Required: Yes

type

  • Type: typing.Literal['QUERY']
  • Required: Yes

RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

RenderingConfigurationTypeDef

templateUri

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

ResultDataTypeDef

document

  • Type:
  • Required: Yes

resultId

  • Type:
  • Required: Yes

relevanceScore

  • Type: typing.Optional[float]

SearchContentRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchContentRequestSearchContentPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

SearchContentResponseTypeDef

contentSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.ContentSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SearchExpressionTypeDef

filters

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.wisdom_classes.FilterTypeDef]
  • Required: Yes

SearchQuickResponsesRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Mapping[str, str]]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchQuickResponsesRequestSearchQuickResponsesPaginateTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

attributes

  • Type: typing.Optional[typing.Mapping[str, str]]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

SearchQuickResponsesResponsePaginatorTypeDef

nextToken

  • Type:
  • Required: Yes

results

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseSearchResultDataPaginatorTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SearchQuickResponsesResponseTypeDef

nextToken

  • Type:
  • Required: Yes

results

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseSearchResultDataTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SearchSessionsRequestRequestTypeDef

assistantId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

SearchSessionsRequestSearchSessionsPaginateTypeDef

assistantId

  • Type:
  • Required: Yes

searchExpression

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.PaginatorConfigTypeDef]

SearchSessionsResponseTypeDef

nextToken

  • Type:
  • Required: Yes

sessionSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.wisdom_classes.SessionSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ServerSideEncryptionConfigurationTypeDef

kmsKeyId

  • Type: typing.Optional[str]

SessionDataTypeDef

name

  • Type:
  • Required: Yes

sessionArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

integrationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.SessionIntegrationConfigurationTypeDef]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

SessionIntegrationConfigurationTypeDef

topicIntegrationArn

  • Type: typing.Optional[str]

SessionSummaryTypeDef

assistantArn

  • Type:
  • Required: Yes

assistantId

  • Type:
  • Required: Yes

sessionArn

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

SourceConfigurationPaginatorTypeDef

appIntegrations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.AppIntegrationsConfigurationPaginatorTypeDef]

SourceConfigurationTypeDef

appIntegrations

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.AppIntegrationsConfigurationTypeDef]

StartContentUploadRequestRequestTypeDef

contentType

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

presignedUrlTimeToLive

  • Type: typing.Optional[int]

StartContentUploadResponseTypeDef

headersToInclude

  • Type: typing.Dict[str, str]
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

urlExpiry

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartImportJobRequestRequestTypeDef

importJobType

  • Type: typing.Literal['QUICK_RESPONSES']
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

uploadId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

externalSourceConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.ExternalSourceConfigurationTypeDef]

metadata

  • Type: typing.Optional[typing.Mapping[str, str]]

StartImportJobResponseTypeDef

importJob

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateContentRequestRequestTypeDef

contentId

  • Type:
  • Required: Yes

knowledgeBaseId

  • Type:
  • Required: Yes

metadata

  • Type: typing.Optional[typing.Mapping[str, str]]

overrideLinkOutUri

  • Type: typing.Optional[str]

removeOverrideLinkOutUri

  • Type: typing.Optional[bool]

revisionId

  • Type: typing.Optional[str]

title

  • Type: typing.Optional[str]

uploadId

  • Type: typing.Optional[str]

UpdateContentResponseTypeDef

content

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

templateUri

  • Type:
  • Required: Yes

UpdateKnowledgeBaseTemplateUriResponseTypeDef

knowledgeBase

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateQuickResponseRequestRequestTypeDef

knowledgeBaseId

  • Type:
  • Required: Yes

quickResponseId

  • Type:
  • Required: Yes

channels

  • Type: typing.Optional[typing.Sequence[str]]

content

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.QuickResponseDataProviderTypeDef]

contentType

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

groupingConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.wisdom_classes.GroupingConfigurationTypeDef]

isActive

  • Type: typing.Optional[bool]

language

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

removeDescription

  • Type: typing.Optional[bool]

removeGroupingConfiguration

  • Type: typing.Optional[bool]

removeShortcutKey

  • Type: typing.Optional[bool]

shortcutKey

  • Type: typing.Optional[str]

UpdateQuickResponseResponseTypeDef

quickResponse

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes