Qconnect Classes
AIAgentConfiguration
answerRecommendationAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AnswerRecommendationAIAgentConfiguration]
manualSearchAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ManualSearchAIAgentConfiguration]
selfServiceAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SelfServiceAIAgentConfiguration]
AIAgentConfigurationData
aiAgentId
- Type:
- Required: Yes
AIAgentConfigurationOutput
answerRecommendationAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AnswerRecommendationAIAgentConfigurationOutput]
manualSearchAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ManualSearchAIAgentConfigurationOutput]
selfServiceAIAgentConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SelfServiceAIAgentConfigurationOutput]
AIAgentData
aiAgentArn
- Type:
- Required: Yes
aiAgentId
- Type:
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
configuration
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type: typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AIAgentSummary
aiAgentArn
- Type:
- Required: Yes
aiAgentId
- Type:
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type: typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
configuration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationOutput]
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AIAgentVersionSummary
aiAgentSummary
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentSummary]
versionNumber
- Type: typing.Optional[int]
AIGuardrailContentPolicyConfig
filtersConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailContentFilterConfig]
- Required: Yes
AIGuardrailContentPolicyConfigOutput
filtersConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailContentFilterConfig]
- Required: Yes
AIGuardrailContextualGroundingPolicyConfig
filtersConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailContextualGroundingFilterConfig]
- Required: Yes
AIGuardrailContextualGroundingPolicyConfigOutput
filtersConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailContextualGroundingFilterConfig]
- Required: Yes
AIGuardrailData
aiGuardrailArn
- Type:
- Required: Yes
aiGuardrailId
- Type:
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
blockedInputMessaging
- Type:
- Required: Yes
blockedOutputsMessaging
- Type:
- Required: Yes
name
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
contentPolicyConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContentPolicyConfigOutput]
contextualGroundingPolicyConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContextualGroundingPolicyConfigOutput]
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
sensitiveInformationPolicyConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSensitiveInformationPolicyConfigOutput]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
topicPolicyConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailTopicPolicyConfigOutput]
wordPolicyConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailWordPolicyConfigOutput]
AIGuardrailSensitiveInformationPolicyConfig
piiEntitiesConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailPiiEntityConfig]]
regexesConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailRegexConfig]]
AIGuardrailSensitiveInformationPolicyConfigOutput
piiEntitiesConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailPiiEntityConfig]]
regexesConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailRegexConfig]]
AIGuardrailSummary
aiGuardrailArn
- Type:
- Required: Yes
aiGuardrailId
- Type:
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AIGuardrailTopicPolicyConfig
topicsConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailTopicConfig]
- Required: Yes
AIGuardrailTopicPolicyConfigOutput
topicsConfig
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailTopicConfigOutput]
- Required: Yes
AIGuardrailVersionSummary
aiGuardrailSummary
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSummary]
versionNumber
- Type: typing.Optional[int]
AIGuardrailWordPolicyConfig
managedWordListsConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailManagedWordsConfig]]
wordsConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailWordConfig]]
AIGuardrailWordPolicyConfigOutput
managedWordListsConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailManagedWordsConfig]]
wordsConfig
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GuardrailWordConfig]]
AIPromptData
aiPromptArn
- Type:
- Required: Yes
aiPromptId
- Type:
- Required: Yes
apiFormat
- Type: typing.Literal['ANTHROPIC_CLAUDE_MESSAGES', 'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS']
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
modelId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
templateConfiguration
- Type:
- Required: Yes
templateType
- Type: typing.Literal['TEXT']
- Required: Yes
type
- Type: typing.Literal['ANSWER_GENERATION', 'INTENT_LABELING_GENERATION', 'QUERY_REFORMULATION', 'SELF_SERVICE_ANSWER_GENERATION', 'SELF_SERVICE_PRE_PROCESSING']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AIPromptSummary
aiPromptArn
- Type:
- Required: Yes
aiPromptId
- Type:
- Required: Yes
apiFormat
- Type: typing.Literal['ANTHROPIC_CLAUDE_MESSAGES', 'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS']
- Required: Yes
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
modelId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
templateType
- Type: typing.Literal['TEXT']
- Required: Yes
type
- Type: typing.Literal['ANSWER_GENERATION', 'INTENT_LABELING_GENERATION', 'QUERY_REFORMULATION', 'SELF_SERVICE_ANSWER_GENERATION', 'SELF_SERVICE_PRE_PROCESSING']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
description
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Optional[datetime.datetime]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
status
- Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'DELETED', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AIPromptTemplateConfiguration
textFullAIPromptEditTemplateConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TextFullAIPromptEditTemplateConfiguration]
AIPromptVersionSummary
aiPromptSummary
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIPromptSummary]
versionNumber
- Type: typing.Optional[int]
ActivateMessageTemplateRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ActivateMessageTemplateResponse
messageTemplateArn
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
AgentAttributes
firstName
- Type: typing.Optional[str]
lastName
- Type: typing.Optional[str]
AmazonConnectGuideAssociationData
flowId
- Type: typing.Optional[str]
AnswerRecommendationAIAgentConfiguration
answerGenerationAIGuardrailId
- Type: typing.Optional[str]
answerGenerationAIPromptId
- Type: typing.Optional[str]
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfiguration]]
intentLabelingGenerationAIPromptId
- Type: typing.Optional[str]
locale
- Type: typing.Optional[str]
queryReformulationAIPromptId
- Type: typing.Optional[str]
AnswerRecommendationAIAgentConfigurationOutput
answerGenerationAIGuardrailId
- Type: typing.Optional[str]
answerGenerationAIPromptId
- Type: typing.Optional[str]
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfigurationOutput]]
intentLabelingGenerationAIPromptId
- Type: typing.Optional[str]
locale
- Type: typing.Optional[str]
queryReformulationAIPromptId
- Type: typing.Optional[str]
AppIntegrationsConfiguration
appIntegrationArn
- Type:
- Required: Yes
objectFields
- Type: typing.Optional[typing.List[str]]
AppIntegrationsConfigurationOutput
appIntegrationArn
- Type:
- Required: Yes
objectFields
- Type: typing.Optional[typing.List[str]]
AssistantAssociationData
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]]
AssistantAssociationInputData
knowledgeBaseId
- Type: typing.Optional[str]
AssistantAssociationOutputData
knowledgeBaseAssociation
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.KnowledgeBaseAssociationData]
AssistantAssociationSummary
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]]
AssistantCapabilityConfiguration
type
- Type: typing.Optional[typing.Literal['V1', 'V2']]
AssistantData
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
aiAgentConfiguration
- Type: typing.Optional[typing.Dict[typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE'], aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationData]]
capabilityConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantCapabilityConfiguration]
description
- Type: typing.Optional[str]
integrationConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantIntegrationConfiguration]
serverSideEncryptionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AssistantIntegrationConfiguration
topicIntegrationArn
- Type: typing.Optional[str]
AssistantSummary
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
aiAgentConfiguration
- Type: typing.Optional[typing.Dict[typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE'], aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationData]]
capabilityConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantCapabilityConfiguration]
description
- Type: typing.Optional[str]
integrationConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantIntegrationConfiguration]
serverSideEncryptionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
tags
- Type: typing.Optional[typing.Dict[str, str]]
AssociationConfiguration
associationConfigurationData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfigurationData]
associationId
- Type: typing.Optional[str]
associationType
- Type: typing.Optional[typing.Literal['KNOWLEDGE_BASE']]
AssociationConfigurationData
knowledgeBaseAssociationConfigurationData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.KnowledgeBaseAssociationConfigurationData]
AssociationConfigurationDataOutput
knowledgeBaseAssociationConfigurationData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.KnowledgeBaseAssociationConfigurationDataOutput]
AssociationConfigurationOutput
associationConfigurationData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfigurationDataOutput]
associationId
- Type: typing.Optional[str]
associationType
- Type: typing.Optional[typing.Literal['KNOWLEDGE_BASE']]
BaseValidatorModel
Oops! This Pydantic model is currently empty. Stay tuned!
BedrockFoundationModelConfigurationForParsing
modelArn
- Type:
- Required: Yes
parsingPrompt
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ParsingPrompt]
ChunkingConfiguration
chunkingStrategy
- Type: typing.Literal['FIXED_SIZE', 'HIERARCHICAL', 'NONE', 'SEMANTIC']
- Required: Yes
fixedSizeChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.FixedSizeChunkingConfiguration]
hierarchicalChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.HierarchicalChunkingConfiguration]
semanticChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SemanticChunkingConfiguration]
ChunkingConfigurationOutput
chunkingStrategy
- Type: typing.Literal['FIXED_SIZE', 'HIERARCHICAL', 'NONE', 'SEMANTIC']
- Required: Yes
fixedSizeChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.FixedSizeChunkingConfiguration]
hierarchicalChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.HierarchicalChunkingConfigurationOutput]
semanticChunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SemanticChunkingConfiguration]
CitationSpan
beginOffsetInclusive
- Type: typing.Optional[int]
endOffsetExclusive
- Type: typing.Optional[int]
Configuration
connectConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ConnectConfiguration]
ConnectConfiguration
instanceId
- Type: typing.Optional[str]
ContentAssociationContents
amazonConnectGuideAssociation
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AmazonConnectGuideAssociationData]
ContentAssociationData
associationData
- Type:
- Required: Yes
associationType
- Type: typing.Literal['AMAZON_CONNECT_GUIDE']
- Required: Yes
contentArn
- Type:
- Required: Yes
contentAssociationArn
- Type:
- Required: Yes
contentAssociationId
- Type:
- Required: Yes
contentId
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
tags
- Type: typing.Optional[typing.Dict[str, str]]
ContentAssociationSummary
associationData
- Type:
- Required: Yes
associationType
- Type: typing.Literal['AMAZON_CONNECT_GUIDE']
- Required: Yes
contentArn
- Type:
- Required: Yes
contentAssociationArn
- Type:
- Required: Yes
contentAssociationId
- Type:
- Required: Yes
contentId
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
tags
- Type: typing.Optional[typing.Dict[str, str]]
ContentData
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]]
ContentDataDetails
rankingData
- Type:
- Required: Yes
textData
- Type:
- Required: Yes
ContentFeedbackData
generativeContentFeedbackData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GenerativeContentFeedbackData]
ContentReference
contentArn
- Type: typing.Optional[str]
contentId
- Type: typing.Optional[str]
knowledgeBaseArn
- Type: typing.Optional[str]
knowledgeBaseId
- Type: typing.Optional[str]
referenceType
- Type: typing.Optional[typing.Literal['KNOWLEDGE_BASE', 'WEB_CRAWLER']]
sourceURL
- Type: typing.Optional[str]
ContentSummary
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]]
ConversationContext
selfServiceConversationHistory
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SelfServiceConversationHistory]
- Required: Yes
ConversationState
status
- Type: typing.Literal['CLOSED', 'PROCESSING', 'READY']
- Required: Yes
reason
- Type: typing.Optional[typing.Literal['FAILED', 'REJECTED', 'SUCCESS']]
CreateAIAgentRequest
assistantId
- Type:
- Required: Yes
configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationOutput]
- Required: Yes
name
- Type:
- Required: Yes
type
- Type: typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateAIAgentResponse
aiAgent
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAIAgentVersionRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Union[datetime.datetime, str, NoneType]
CreateAIAgentVersionResponse
aiAgent
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAIGuardrailRequest
assistantId
- Type:
- Required: Yes
blockedInputMessaging
- Type:
- Required: Yes
blockedOutputsMessaging
- Type:
- Required: Yes
name
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
contentPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContentPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContentPolicyConfigOutput, NoneType]
contextualGroundingPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContextualGroundingPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContextualGroundingPolicyConfigOutput, NoneType]
description
- Type: typing.Optional[str]
sensitiveInformationPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSensitiveInformationPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSensitiveInformationPolicyConfigOutput, NoneType]
tags
- Type: typing.Optional[typing.Dict[str, str]]
topicPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailTopicPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailTopicPolicyConfigOutput, NoneType]
wordPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailWordPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailWordPolicyConfigOutput, NoneType]
CreateAIGuardrailResponse
aiGuardrail
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAIGuardrailVersionRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Union[datetime.datetime, str, NoneType]
CreateAIGuardrailVersionResponse
aiGuardrail
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAIPromptRequest
apiFormat
- Type: typing.Literal['ANTHROPIC_CLAUDE_MESSAGES', 'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS']
- Required: Yes
assistantId
- Type:
- Required: Yes
modelId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
templateConfiguration
- Type:
- Required: Yes
templateType
- Type: typing.Literal['TEXT']
- Required: Yes
type
- Type: typing.Literal['ANSWER_GENERATION', 'INTENT_LABELING_GENERATION', 'QUERY_REFORMULATION', 'SELF_SERVICE_ANSWER_GENERATION', 'SELF_SERVICE_PRE_PROCESSING']
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateAIPromptResponse
aiPrompt
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAIPromptVersionRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
modifiedTime
- Type: typing.Union[datetime.datetime, str, NoneType]
CreateAIPromptVersionResponse
aiPrompt
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAssistantAssociationRequest
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.Dict[str, str]]
CreateAssistantAssociationResponse
assistantAssociation
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAssistantRequest
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.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateAssistantResponse
assistant
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateContentAssociationRequest
association
- Type:
- Required: Yes
associationType
- Type: typing.Literal['AMAZON_CONNECT_GUIDE']
- Required: Yes
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateContentAssociationResponse
contentAssociation
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateContentRequest
knowledgeBaseId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
uploadId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
metadata
- Type: typing.Optional[typing.Dict[str, str]]
overrideLinkOutUri
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
title
- Type: typing.Optional[str]
CreateContentResponse
content
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateKnowledgeBaseRequest
knowledgeBaseType
- Type: typing.Literal['CUSTOM', 'EXTERNAL', 'MANAGED', 'MESSAGE_TEMPLATES', '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.qconnect.qconnect_classes.RenderingConfiguration]
serverSideEncryptionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
sourceConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceConfigurationOutput, NoneType]
tags
- Type: typing.Optional[typing.Dict[str, str]]
vectorIngestionConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.VectorIngestionConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.VectorIngestionConfigurationOutput, NoneType]
CreateKnowledgeBaseResponse
knowledgeBase
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateMessageTemplateAttachmentRequest
body
- Type:
- Required: Yes
contentDisposition
- Type: typing.Literal['ATTACHMENT']
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
CreateMessageTemplateAttachmentResponse
attachment
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateMessageTemplateRequest
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
content
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateContentProvider, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateContentProviderOutput]
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
defaultAttributes
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributes, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributesOutput, NoneType]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput, NoneType]
language
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateMessageTemplateResponse
messageTemplate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateMessageTemplateVersionRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
messageTemplateContentSha256
- Type: typing.Optional[str]
CreateMessageTemplateVersionResponse
messageTemplate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateQuickResponseRequest
content
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
channels
- Type: typing.Optional[typing.List[str]]
clientToken
- Type: typing.Optional[str]
contentType
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput, NoneType]
isActive
- Type: typing.Optional[bool]
language
- Type: typing.Optional[str]
shortcutKey
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateQuickResponseResponse
quickResponse
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateSessionRequest
assistantId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
aiAgentConfiguration
- Type: typing.Optional[typing.Dict[typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE'], aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationData]]
clientToken
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
tagFilter
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilter, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilterOutput, NoneType]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateSessionResponse
session
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CustomerProfileAttributes
accountNumber
- Type: typing.Optional[str]
additionalInformation
- Type: typing.Optional[str]
address1
- Type: typing.Optional[str]
address2
- Type: typing.Optional[str]
address3
- Type: typing.Optional[str]
address4
- Type: typing.Optional[str]
billingAddress1
- Type: typing.Optional[str]
billingAddress2
- Type: typing.Optional[str]
billingAddress3
- Type: typing.Optional[str]
billingAddress4
- Type: typing.Optional[str]
billingCity
- Type: typing.Optional[str]
billingCountry
- Type: typing.Optional[str]
billingCounty
- Type: typing.Optional[str]
billingPostalCode
- Type: typing.Optional[str]
billingProvince
- Type: typing.Optional[str]
billingState
- Type: typing.Optional[str]
birthDate
- Type: typing.Optional[str]
businessEmailAddress
- Type: typing.Optional[str]
businessName
- Type: typing.Optional[str]
businessPhoneNumber
- Type: typing.Optional[str]
city
- Type: typing.Optional[str]
country
- Type: typing.Optional[str]
county
- Type: typing.Optional[str]
custom
- Type: typing.Optional[typing.Dict[str, str]]
emailAddress
- Type: typing.Optional[str]
firstName
- Type: typing.Optional[str]
gender
- Type: typing.Optional[str]
homePhoneNumber
- Type: typing.Optional[str]
lastName
- Type: typing.Optional[str]
mailingAddress1
- Type: typing.Optional[str]
mailingAddress2
- Type: typing.Optional[str]
mailingAddress3
- Type: typing.Optional[str]
mailingAddress4
- Type: typing.Optional[str]
mailingCity
- Type: typing.Optional[str]
mailingCountry
- Type: typing.Optional[str]
mailingCounty
- Type: typing.Optional[str]
mailingPostalCode
- Type: typing.Optional[str]
mailingProvince
- Type: typing.Optional[str]
mailingState
- Type: typing.Optional[str]
middleName
- Type: typing.Optional[str]
mobilePhoneNumber
- Type: typing.Optional[str]
partyType
- Type: typing.Optional[str]
phoneNumber
- Type: typing.Optional[str]
postalCode
- Type: typing.Optional[str]
profileARN
- Type: typing.Optional[str]
profileId
- Type: typing.Optional[str]
province
- Type: typing.Optional[str]
shippingAddress1
- Type: typing.Optional[str]
shippingAddress2
- Type: typing.Optional[str]
shippingAddress3
- Type: typing.Optional[str]
shippingAddress4
- Type: typing.Optional[str]
shippingCity
- Type: typing.Optional[str]
shippingCountry
- Type: typing.Optional[str]
shippingCounty
- Type: typing.Optional[str]
shippingPostalCode
- Type: typing.Optional[str]
shippingProvince
- Type: typing.Optional[str]
shippingState
- Type: typing.Optional[str]
state
- Type: typing.Optional[str]
CustomerProfileAttributesOutput
accountNumber
- Type: typing.Optional[str]
additionalInformation
- Type: typing.Optional[str]
address1
- Type: typing.Optional[str]
address2
- Type: typing.Optional[str]
address3
- Type: typing.Optional[str]
address4
- Type: typing.Optional[str]
billingAddress1
- Type: typing.Optional[str]
billingAddress2
- Type: typing.Optional[str]
billingAddress3
- Type: typing.Optional[str]
billingAddress4
- Type: typing.Optional[str]
billingCity
- Type: typing.Optional[str]
billingCountry
- Type: typing.Optional[str]
billingCounty
- Type: typing.Optional[str]
billingPostalCode
- Type: typing.Optional[str]
billingProvince
- Type: typing.Optional[str]
billingState
- Type: typing.Optional[str]
birthDate
- Type: typing.Optional[str]
businessEmailAddress
- Type: typing.Optional[str]
businessName
- Type: typing.Optional[str]
businessPhoneNumber
- Type: typing.Optional[str]
city
- Type: typing.Optional[str]
country
- Type: typing.Optional[str]
county
- Type: typing.Optional[str]
custom
- Type: typing.Optional[typing.Dict[str, str]]
emailAddress
- Type: typing.Optional[str]
firstName
- Type: typing.Optional[str]
gender
- Type: typing.Optional[str]
homePhoneNumber
- Type: typing.Optional[str]
lastName
- Type: typing.Optional[str]
mailingAddress1
- Type: typing.Optional[str]
mailingAddress2
- Type: typing.Optional[str]
mailingAddress3
- Type: typing.Optional[str]
mailingAddress4
- Type: typing.Optional[str]
mailingCity
- Type: typing.Optional[str]
mailingCountry
- Type: typing.Optional[str]
mailingCounty
- Type: typing.Optional[str]
mailingPostalCode
- Type: typing.Optional[str]
mailingProvince
- Type: typing.Optional[str]
mailingState
- Type: typing.Optional[str]
middleName
- Type: typing.Optional[str]
mobilePhoneNumber
- Type: typing.Optional[str]
partyType
- Type: typing.Optional[str]
phoneNumber
- Type: typing.Optional[str]
postalCode
- Type: typing.Optional[str]
profileARN
- Type: typing.Optional[str]
profileId
- Type: typing.Optional[str]
province
- Type: typing.Optional[str]
shippingAddress1
- Type: typing.Optional[str]
shippingAddress2
- Type: typing.Optional[str]
shippingAddress3
- Type: typing.Optional[str]
shippingAddress4
- Type: typing.Optional[str]
shippingCity
- Type: typing.Optional[str]
shippingCountry
- Type: typing.Optional[str]
shippingCounty
- Type: typing.Optional[str]
shippingPostalCode
- Type: typing.Optional[str]
shippingProvince
- Type: typing.Optional[str]
shippingState
- Type: typing.Optional[str]
state
- Type: typing.Optional[str]
DataDetails
contentData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentDataDetails]
generativeData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GenerativeDataDetails]
intentDetectedData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.IntentDetectedDataDetails]
sourceContentData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceContentDataDetails]
DataDetailsPaginator
contentData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentDataDetails]
generativeData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GenerativeDataDetailsPaginator]
intentDetectedData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.IntentDetectedDataDetails]
sourceContentData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceContentDataDetails]
DataReference
contentReference
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentReference]
generativeReference
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GenerativeReference]
DataSummary
details
- Type:
- Required: Yes
reference
- Type:
- Required: Yes
DataSummaryPaginator
details
- Type:
- Required: Yes
reference
- Type:
- Required: Yes
DeactivateMessageTemplateRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
DeactivateMessageTemplateResponse
messageTemplateArn
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteAIAgentRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
DeleteAIAgentVersionRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
DeleteAIGuardrailRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
DeleteAIGuardrailVersionRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
DeleteAIPromptRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
DeleteAIPromptVersionRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
DeleteAssistantAssociationRequest
assistantAssociationId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
DeleteAssistantRequest
assistantId
- Type:
- Required: Yes
DeleteContentAssociationRequest
contentAssociationId
- Type:
- Required: Yes
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
DeleteContentRequest
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
DeleteImportJobRequest
importJobId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
DeleteKnowledgeBaseRequest
knowledgeBaseId
- Type:
- Required: Yes
DeleteMessageTemplateAttachmentRequest
attachmentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
DeleteMessageTemplateRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
DeleteQuickResponseRequest
knowledgeBaseId
- Type:
- Required: Yes
quickResponseId
- Type:
- Required: Yes
Document
contentReference
- Type:
- Required: Yes
excerpt
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DocumentText]
title
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DocumentText]
DocumentText
highlights
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.Highlight]]
text
- Type: typing.Optional[str]
EmailHeader
name
- Type: typing.Optional[str]
value
- Type: typing.Optional[str]
EmailMessageTemplateContent
body
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailMessageTemplateContentBody]
headers
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailHeader]]
subject
- Type: typing.Optional[str]
EmailMessageTemplateContentBody
html
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateBodyContentProvider]
plainText
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateBodyContentProvider]
EmailMessageTemplateContentOutput
body
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailMessageTemplateContentBody]
headers
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailHeader]]
subject
- Type: typing.Optional[str]
ExtendedMessageTemplateData
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
content
- Type:
- Required: Yes
createdTime
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
lastModifiedBy
- Type:
- Required: Yes
lastModifiedTime
- Type:
- Required: Yes
messageTemplateArn
- Type:
- Required: Yes
messageTemplateContentSha256
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
attachments
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttachment]]
attributeTypes
- Type: typing.Optional[typing.List[typing.Literal['AGENT', 'CUSTOM', 'CUSTOMER_PROFILE', 'SYSTEM']]]
defaultAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributesOutput]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput]
isActive
- Type: typing.Optional[bool]
language
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
versionNumber
- Type: typing.Optional[int]
ExternalSourceConfiguration
configuration
- Type:
- Required: Yes
source
- Type: typing.Literal['AMAZON_CONNECT']
- Required: Yes
Filter
field
- Type: typing.Literal['NAME']
- Required: Yes
operator
- Type: typing.Literal['EQUALS']
- Required: Yes
value
- Type:
- Required: Yes
FixedSizeChunkingConfiguration
maxTokens
- Type:
- Required: Yes
overlapPercentage
- Type:
- Required: Yes
GenerativeContentFeedbackData
relevance
- Type: typing.Literal['HELPFUL', 'NOT_HELPFUL']
- Required: Yes
GenerativeDataDetails
completion
- Type:
- Required: Yes
rankingData
- Type:
- Required: Yes
references
- Type: typing.List[typing.Dict[str, typing.Any]]
- Required: Yes
GenerativeDataDetailsPaginator
completion
- Type:
- Required: Yes
rankingData
- Type:
- Required: Yes
references
- Type: typing.List[typing.Dict[str, typing.Any]]
- Required: Yes
GenerativeReference
generationId
- Type: typing.Optional[str]
modelId
- Type: typing.Optional[str]
GetAIAgentRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
GetAIAgentResponse
aiAgent
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAIGuardrailRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
GetAIGuardrailResponse
aiGuardrail
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAIPromptRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
GetAIPromptResponse
aiPrompt
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAssistantAssociationRequest
assistantAssociationId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
GetAssistantAssociationResponse
assistantAssociation
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAssistantRequest
assistantId
- Type:
- Required: Yes
GetAssistantResponse
assistant
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetContentAssociationRequest
contentAssociationId
- Type:
- Required: Yes
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
GetContentAssociationResponse
contentAssociation
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetContentRequest
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
GetContentResponse
content
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetContentSummaryRequest
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
GetContentSummaryResponse
contentSummary
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetImportJobRequest
importJobId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
GetImportJobResponse
importJob
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetKnowledgeBaseRequest
knowledgeBaseId
- Type:
- Required: Yes
GetKnowledgeBaseResponse
knowledgeBase
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetMessageTemplateRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
GetMessageTemplateResponse
messageTemplate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetNextMessageRequest
assistantId
- Type:
- Required: Yes
nextMessageToken
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
GetNextMessageResponse
conversationSessionData
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RuntimeSessionData]
- Required: Yes
conversationState
- Type:
- Required: Yes
nextMessageToken
- Type:
- Required: Yes
requestMessageId
- Type:
- Required: Yes
response
- Type:
- Required: Yes
type
- Type: typing.Literal['TEXT']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetQuickResponseRequest
knowledgeBaseId
- Type:
- Required: Yes
quickResponseId
- Type:
- Required: Yes
GetQuickResponseResponse
quickResponse
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetRecommendationsRequest
assistantId
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
waitTimeSeconds
- Type: typing.Optional[int]
GetRecommendationsResponse
recommendations
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RecommendationData]
- Required: Yes
triggers
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RecommendationTrigger]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetSessionRequest
assistantId
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
GetSessionResponse
session
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GroupingConfiguration
criteria
- Type: typing.Optional[str]
values
- Type: typing.Optional[typing.List[str]]
GroupingConfigurationOutput
criteria
- Type: typing.Optional[str]
values
- Type: typing.Optional[typing.List[str]]
GuardrailContentFilterConfig
inputStrength
- Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE']
- Required: Yes
outputStrength
- Type: typing.Literal['HIGH', 'LOW', 'MEDIUM', 'NONE']
- Required: Yes
type
- Type: typing.Literal['HATE', 'INSULTS', 'MISCONDUCT', 'PROMPT_ATTACK', 'SEXUAL', 'VIOLENCE']
- Required: Yes
GuardrailContextualGroundingFilterConfig
threshold
- Type:
- Required: Yes
type
- Type: typing.Literal['GROUNDING', 'RELEVANCE']
- Required: Yes
GuardrailManagedWordsConfig
type
- Type: typing.Literal['PROFANITY']
- Required: Yes
GuardrailPiiEntityConfig
action
- Type: typing.Literal['ANONYMIZE', 'BLOCK']
- Required: Yes
type
- Type: typing.Literal['ADDRESS', 'AGE', 'AWS_ACCESS_KEY', 'AWS_SECRET_KEY', 'CA_HEALTH_NUMBER', 'CA_SOCIAL_INSURANCE_NUMBER', 'CREDIT_DEBIT_CARD_CVV', 'CREDIT_DEBIT_CARD_EXPIRY', 'CREDIT_DEBIT_CARD_NUMBER', 'DRIVER_ID', 'EMAIL', 'INTERNATIONAL_BANK_ACCOUNT_NUMBER', 'IP_ADDRESS', 'LICENSE_PLATE', 'MAC_ADDRESS', 'NAME', 'PASSWORD', 'PHONE', 'PIN', 'SWIFT_CODE', 'UK_NATIONAL_HEALTH_SERVICE_NUMBER', 'UK_NATIONAL_INSURANCE_NUMBER', 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER', 'URL', 'USERNAME', 'US_BANK_ACCOUNT_NUMBER', 'US_BANK_ROUTING_NUMBER', 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER', 'US_PASSPORT_NUMBER', 'US_SOCIAL_SECURITY_NUMBER', 'VEHICLE_IDENTIFICATION_NUMBER']
- Required: Yes
GuardrailRegexConfig
action
- Type: typing.Literal['ANONYMIZE', 'BLOCK']
- Required: Yes
name
- Type:
- Required: Yes
pattern
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
GuardrailTopicConfig
definition
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type: typing.Literal['DENY']
- Required: Yes
examples
- Type: typing.Optional[typing.List[str]]
GuardrailTopicConfigOutput
definition
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type: typing.Literal['DENY']
- Required: Yes
examples
- Type: typing.Optional[typing.List[str]]
GuardrailWordConfig
text
- Type:
- Required: Yes
HierarchicalChunkingConfiguration
levelConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.HierarchicalChunkingLevelConfiguration]
- Required: Yes
overlapTokens
- Type:
- Required: Yes
HierarchicalChunkingConfigurationOutput
levelConfigurations
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.HierarchicalChunkingLevelConfiguration]
- Required: Yes
overlapTokens
- Type:
- Required: Yes
HierarchicalChunkingLevelConfiguration
maxTokens
- Type:
- Required: Yes
Highlight
beginOffsetInclusive
- Type: typing.Optional[int]
endOffsetExclusive
- Type: typing.Optional[int]
ImportJobData
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.qconnect.qconnect_classes.ExternalSourceConfiguration]
failedRecordReport
- Type: typing.Optional[str]
metadata
- Type: typing.Optional[typing.Dict[str, str]]
ImportJobSummary
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.qconnect.qconnect_classes.ExternalSourceConfiguration]
metadata
- Type: typing.Optional[typing.Dict[str, str]]
IntentDetectedDataDetails
intent
- Type:
- Required: Yes
intentId
- Type:
- Required: Yes
IntentInputData
intentId
- Type:
- Required: Yes
KnowledgeBaseAssociationConfigurationData
contentTagFilter
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilter]
maxResults
- Type: typing.Optional[int]
overrideKnowledgeBaseSearchType
- Type: typing.Optional[typing.Literal['HYBRID', 'SEMANTIC']]
KnowledgeBaseAssociationConfigurationDataOutput
contentTagFilter
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilterOutput]
maxResults
- Type: typing.Optional[int]
overrideKnowledgeBaseSearchType
- Type: typing.Optional[typing.Literal['HYBRID', 'SEMANTIC']]
KnowledgeBaseAssociationData
knowledgeBaseArn
- Type: typing.Optional[str]
knowledgeBaseId
- Type: typing.Optional[str]
KnowledgeBaseData
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
knowledgeBaseType
- Type: typing.Literal['CUSTOM', 'EXTERNAL', 'MANAGED', 'MESSAGE_TEMPLATES', '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]
ingestionFailureReasons
- Type: typing.Optional[typing.List[str]]
ingestionStatus
- Type: typing.Optional[typing.Literal['CREATE_IN_PROGRESS', 'SYNCING_IN_PROGRESS', 'SYNC_FAILED', 'SYNC_SUCCESS']]
lastContentModificationTime
- Type: typing.Optional[datetime.datetime]
renderingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RenderingConfiguration]
serverSideEncryptionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
sourceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceConfigurationOutput]
tags
- Type: typing.Optional[typing.Dict[str, str]]
vectorIngestionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.VectorIngestionConfigurationOutput]
KnowledgeBaseSummary
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
knowledgeBaseType
- Type: typing.Literal['CUSTOM', 'EXTERNAL', 'MANAGED', 'MESSAGE_TEMPLATES', '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.qconnect.qconnect_classes.RenderingConfiguration]
serverSideEncryptionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ServerSideEncryptionConfiguration]
sourceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SourceConfigurationOutput]
tags
- Type: typing.Optional[typing.Dict[str, str]]
vectorIngestionConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.VectorIngestionConfigurationOutput]
ListAIAgentVersionsRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
ListAIAgentVersionsRequestPaginate
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIAgentVersionsResponse
aiAgentVersionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentVersionSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAIAgentsRequest
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
ListAIAgentsRequestPaginate
assistantId
- Type:
- Required: Yes
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIAgentsResponse
aiAgentSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAIGuardrailVersionsRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListAIGuardrailVersionsRequestPaginate
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIGuardrailVersionsResponse
aiGuardrailVersionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailVersionSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAIGuardrailsRequest
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListAIGuardrailsRequestPaginate
assistantId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIGuardrailsResponse
aiGuardrailSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAIPromptVersionsRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
ListAIPromptVersionsRequestPaginate
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIPromptVersionsResponse
aiPromptVersionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIPromptVersionSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAIPromptsRequest
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
ListAIPromptsRequestPaginate
assistantId
- Type:
- Required: Yes
origin
- Type: typing.Optional[typing.Literal['CUSTOMER', 'SYSTEM']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAIPromptsResponse
aiPromptSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIPromptSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAssistantAssociationsRequest
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListAssistantAssociationsRequestPaginate
assistantId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAssistantAssociationsResponse
assistantAssociationSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantAssociationSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListAssistantsRequest
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListAssistantsRequestPaginate
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListAssistantsResponse
assistantSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssistantSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListContentAssociationsRequest
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListContentAssociationsRequestPaginate
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListContentAssociationsResponse
contentAssociationSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentAssociationSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListContentsRequest
knowledgeBaseId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListContentsRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListContentsResponse
contentSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListImportJobsRequest
knowledgeBaseId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListImportJobsRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListImportJobsResponse
importJobSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ImportJobSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListKnowledgeBasesRequest
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListKnowledgeBasesRequestPaginate
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListKnowledgeBasesResponse
knowledgeBaseSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.KnowledgeBaseSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListMessageTemplateVersionsRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListMessageTemplateVersionsRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListMessageTemplateVersionsResponse
messageTemplateVersionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateVersionSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListMessageTemplatesRequest
knowledgeBaseId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListMessageTemplatesRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListMessageTemplatesResponse
messageTemplateSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListMessagesRequest
assistantId
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListMessagesRequestPaginate
assistantId
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListMessagesResponse
messages
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageOutput]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListQuickResponsesRequest
knowledgeBaseId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListQuickResponsesRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
ListQuickResponsesResponse
quickResponseSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListTagsForResourceRequest
resourceArn
- Type:
- Required: Yes
ListTagsForResourceResponse
tags
- Type: typing.Dict[str, str]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ManagedSourceConfiguration
webCrawlerConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.WebCrawlerConfiguration]
ManagedSourceConfigurationOutput
webCrawlerConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.WebCrawlerConfigurationOutput]
ManualSearchAIAgentConfiguration
answerGenerationAIGuardrailId
- Type: typing.Optional[str]
answerGenerationAIPromptId
- Type: typing.Optional[str]
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfiguration]]
locale
- Type: typing.Optional[str]
ManualSearchAIAgentConfigurationOutput
answerGenerationAIGuardrailId
- Type: typing.Optional[str]
answerGenerationAIPromptId
- Type: typing.Optional[str]
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfigurationOutput]]
locale
- Type: typing.Optional[str]
MessageData
text
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TextMessage]
MessageInput
value
- Type:
- Required: Yes
MessageOutput
messageId
- Type:
- Required: Yes
participant
- Type: typing.Literal['AGENT', 'BOT', 'CUSTOMER']
- Required: Yes
timestamp
- Type:
- Required: Yes
value
- Type:
- Required: Yes
MessageTemplateAttachment
attachmentId
- Type:
- Required: Yes
contentDisposition
- Type: typing.Literal['ATTACHMENT']
- Required: Yes
name
- Type:
- Required: Yes
uploadedTime
- Type:
- Required: Yes
url
- Type:
- Required: Yes
urlExpiry
- Type:
- Required: Yes
MessageTemplateAttributes
agentAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AgentAttributes]
customAttributes
- Type: typing.Optional[typing.Dict[str, str]]
customerProfileAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.CustomerProfileAttributes]
systemAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SystemAttributes]
MessageTemplateAttributesOutput
agentAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AgentAttributes]
customAttributes
- Type: typing.Optional[typing.Dict[str, str]]
customerProfileAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.CustomerProfileAttributesOutput]
systemAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SystemAttributes]
MessageTemplateBodyContentProvider
content
- Type: typing.Optional[str]
MessageTemplateContentProvider
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailMessageTemplateContent]
sms
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SMSMessageTemplateContent]
MessageTemplateContentProviderOutput
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.EmailMessageTemplateContentOutput]
sms
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SMSMessageTemplateContent]
MessageTemplateData
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
content
- Type:
- Required: Yes
createdTime
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
lastModifiedBy
- Type:
- Required: Yes
lastModifiedTime
- Type:
- Required: Yes
messageTemplateArn
- Type:
- Required: Yes
messageTemplateContentSha256
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
attributeTypes
- Type: typing.Optional[typing.List[typing.Literal['AGENT', 'CUSTOM', 'CUSTOMER_PROFILE', 'SYSTEM']]]
defaultAttributes
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributesOutput]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput]
language
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
MessageTemplateFilterField
name
- Type:
- Required: Yes
operator
- Type: typing.Literal['EQUALS', 'PREFIX']
- Required: Yes
includeNoExistence
- Type: typing.Optional[bool]
values
- Type: typing.Optional[typing.List[str]]
MessageTemplateOrderField
name
- Type:
- Required: Yes
order
- Type: typing.Optional[typing.Literal['ASC', 'DESC']]
MessageTemplateQueryField
name
- Type:
- Required: Yes
operator
- Type: typing.Literal['CONTAINS', 'CONTAINS_AND_PREFIX']
- Required: Yes
values
- Type: typing.List[str]
- Required: Yes
allowFuzziness
- Type: typing.Optional[bool]
priority
- Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]
MessageTemplateSearchExpression
filters
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateFilterField]]
orderOnField
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateOrderField]
queries
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateQueryField]]
MessageTemplateSearchResultData
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
createdTime
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
lastModifiedBy
- Type:
- Required: Yes
lastModifiedTime
- Type:
- Required: Yes
messageTemplateArn
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput]
isActive
- Type: typing.Optional[bool]
language
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
versionNumber
- Type: typing.Optional[int]
MessageTemplateSummary
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
createdTime
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
lastModifiedBy
- Type:
- Required: Yes
lastModifiedTime
- Type:
- Required: Yes
messageTemplateArn
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
activeVersionNumber
- Type: typing.Optional[int]
description
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
MessageTemplateVersionSummary
channelSubtype
- Type: typing.Literal['EMAIL', 'SMS']
- Required: Yes
isActive
- Type:
- Required: Yes
knowledgeBaseArn
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateArn
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
name
- Type:
- Required: Yes
versionNumber
- Type:
- Required: Yes
NotifyRecommendationsReceivedError
message
- Type: typing.Optional[str]
recommendationId
- Type: typing.Optional[str]
NotifyRecommendationsReceivedRequest
assistantId
- Type:
- Required: Yes
recommendationIds
- Type: typing.List[str]
- Required: Yes
sessionId
- Type:
- Required: Yes
NotifyRecommendationsReceivedResponse
errors
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.NotifyRecommendationsReceivedError]
- Required: Yes
recommendationIds
- Type: typing.List[str]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
OrCondition
andConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]]
tagCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]
OrConditionOutput
andConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]]
tagCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]
PaginatorConfig
MaxItems
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
StartingToken
- Type: typing.Optional[str]
ParsingConfiguration
parsingStrategy
- Type: typing.Literal['BEDROCK_FOUNDATION_MODEL']
- Required: Yes
bedrockFoundationModelConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.BedrockFoundationModelConfigurationForParsing]
ParsingPrompt
parsingPromptText
- Type:
- Required: Yes
PutFeedbackRequest
assistantId
- Type:
- Required: Yes
contentFeedback
- Type:
- Required: Yes
targetId
- Type:
- Required: Yes
targetType
- Type: typing.Literal['RECOMMENDATION', 'RESULT']
- Required: Yes
PutFeedbackResponse
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
contentFeedback
- Type:
- Required: Yes
targetId
- Type:
- Required: Yes
targetType
- Type: typing.Literal['RECOMMENDATION', 'RESULT']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
QueryAssistantRequest
assistantId
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
overrideKnowledgeBaseSearchType
- Type: typing.Optional[typing.Literal['HYBRID', 'SEMANTIC']]
queryCondition
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryCondition]]
queryInputData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryInputData]
queryText
- Type: typing.Optional[str]
sessionId
- Type: typing.Optional[str]
QueryAssistantRequestPaginate
assistantId
- Type:
- Required: Yes
overrideKnowledgeBaseSearchType
- Type: typing.Optional[typing.Literal['HYBRID', 'SEMANTIC']]
queryCondition
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryCondition]]
queryInputData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryInputData]
queryText
- Type: typing.Optional[str]
sessionId
- Type: typing.Optional[str]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
QueryAssistantResponse
results
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ResultData]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
QueryAssistantResponsePaginator
results
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ResultDataPaginator]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
QueryCondition
single
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryConditionItem]
QueryConditionItem
comparator
- Type: typing.Literal['EQUALS']
- Required: Yes
field
- Type: typing.Literal['RESULT_TYPE']
- Required: Yes
value
- Type:
- Required: Yes
QueryInputData
intentInputData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.IntentInputData]
queryTextInputData
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryTextInputData]
QueryRecommendationTriggerData
text
- Type: typing.Optional[str]
QueryTextInputData
text
- Type:
- Required: Yes
QuickResponseContentProvider
content
- Type: typing.Optional[str]
QuickResponseContents
markdown
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseContentProvider]
plainText
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseContentProvider]
QuickResponseData
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.qconnect.qconnect_classes.QuickResponseContents]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput]
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]]
QuickResponseDataProvider
content
- Type: typing.Optional[str]
QuickResponseFilterField
name
- Type:
- Required: Yes
operator
- Type: typing.Literal['EQUALS', 'PREFIX']
- Required: Yes
includeNoExistence
- Type: typing.Optional[bool]
values
- Type: typing.Optional[typing.List[str]]
QuickResponseOrderField
name
- Type:
- Required: Yes
order
- Type: typing.Optional[typing.Literal['ASC', 'DESC']]
QuickResponseQueryField
name
- Type:
- Required: Yes
operator
- Type: typing.Literal['CONTAINS', 'CONTAINS_AND_PREFIX']
- Required: Yes
values
- Type: typing.List[str]
- Required: Yes
allowFuzziness
- Type: typing.Optional[bool]
priority
- Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]
QuickResponseSearchExpression
filters
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseFilterField]]
orderOnField
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseOrderField]
queries
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseQueryField]]
QuickResponseSearchResultData
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.qconnect.qconnect_classes.GroupingConfigurationOutput]
language
- Type: typing.Optional[str]
lastModifiedBy
- Type: typing.Optional[str]
shortcutKey
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Dict[str, str]]
QuickResponseSummary
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]]
RankingData
relevanceLevel
- Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]
relevanceScore
- Type: typing.Optional[float]
RecommendationData
recommendationId
- Type:
- Required: Yes
data
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DataSummary]
document
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.Document]
relevanceLevel
- Type: typing.Optional[typing.Literal['HIGH', 'LOW', 'MEDIUM']]
relevanceScore
- Type: typing.Optional[float]
type
- Type: typing.Optional[typing.Literal['DETECTED_INTENT', 'GENERATIVE_ANSWER', 'GENERATIVE_RESPONSE', 'KNOWLEDGE_CONTENT']]
RecommendationTrigger
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['GENERATIVE', 'QUERY']
- Required: Yes
RecommendationTriggerData
query
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QueryRecommendationTriggerData]
RemoveAssistantAIAgentRequest
aiAgentType
- Type: typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE']
- Required: Yes
assistantId
- Type:
- Required: Yes
RemoveKnowledgeBaseTemplateUriRequest
knowledgeBaseId
- Type:
- Required: Yes
RenderMessageTemplateRequest
attributes
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributes, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributesOutput]
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
RenderMessageTemplateResponse
attachments
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttachment]
- Required: Yes
attributesNotInterpolated
- Type: typing.List[str]
- Required: Yes
content
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
RenderingConfiguration
templateUri
- Type: typing.Optional[str]
ResponseMetadata
RequestId
- Type:
- Required: Yes
HTTPStatusCode
- Type:
- Required: Yes
HTTPHeaders
- Type: typing.Dict[str, str]
- Required: Yes
RetryAttempts
- Type:
- Required: Yes
HostId
- Type: typing.Optional[str]
ResultData
resultId
- Type:
- Required: Yes
data
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DataSummary]
document
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.Document]
relevanceScore
- Type: typing.Optional[float]
type
- Type: typing.Optional[typing.Literal['GENERATIVE_ANSWER', 'INTENT_ANSWER', 'KNOWLEDGE_CONTENT']]
ResultDataPaginator
resultId
- Type:
- Required: Yes
data
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DataSummaryPaginator]
document
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.Document]
relevanceScore
- Type: typing.Optional[float]
type
- Type: typing.Optional[typing.Literal['GENERATIVE_ANSWER', 'INTENT_ANSWER', 'KNOWLEDGE_CONTENT']]
RuntimeSessionData
key
- Type:
- Required: Yes
value
- Type:
- Required: Yes
RuntimeSessionDataValue
stringValue
- Type: typing.Optional[str]
SMSMessageTemplateContent
body
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SMSMessageTemplateContentBody]
SMSMessageTemplateContentBody
plainText
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateBodyContentProvider]
SearchContentRequest
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
SearchContentRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
SearchContentResponse
contentSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ContentSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
SearchExpression
filters
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.Filter]
- Required: Yes
SearchMessageTemplatesRequest
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
SearchMessageTemplatesRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
SearchMessageTemplatesResponse
results
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateSearchResultData]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
SearchQuickResponsesRequest
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
attributes
- Type: typing.Optional[typing.Dict[str, str]]
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
SearchQuickResponsesRequestPaginate
knowledgeBaseId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
attributes
- Type: typing.Optional[typing.Dict[str, str]]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
SearchQuickResponsesResponse
results
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseSearchResultData]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
SearchSessionsRequest
assistantId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
SearchSessionsRequestPaginate
assistantId
- Type:
- Required: Yes
searchExpression
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.PaginatorConfig]
SearchSessionsResponse
sessionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SessionSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
SeedUrl
url
- Type: typing.Optional[str]
SelfServiceAIAgentConfiguration
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfiguration]]
selfServiceAIGuardrailId
- Type: typing.Optional[str]
selfServiceAnswerGenerationAIPromptId
- Type: typing.Optional[str]
selfServicePreProcessingAIPromptId
- Type: typing.Optional[str]
SelfServiceAIAgentConfigurationOutput
associationConfigurations
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AssociationConfigurationOutput]]
selfServiceAIGuardrailId
- Type: typing.Optional[str]
selfServiceAnswerGenerationAIPromptId
- Type: typing.Optional[str]
selfServicePreProcessingAIPromptId
- Type: typing.Optional[str]
SelfServiceConversationHistory
turnNumber
- Type:
- Required: Yes
botResponse
- Type: typing.Optional[str]
inputTranscript
- Type: typing.Optional[str]
SemanticChunkingConfiguration
breakpointPercentileThreshold
- Type:
- Required: Yes
bufferSize
- Type:
- Required: Yes
maxTokens
- Type:
- Required: Yes
SendMessageRequest
assistantId
- Type:
- Required: Yes
message
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
type
- Type: typing.Literal['TEXT']
- Required: Yes
clientToken
- Type: typing.Optional[str]
conversationContext
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ConversationContext]
SendMessageResponse
nextMessageToken
- Type:
- Required: Yes
requestMessageId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ServerSideEncryptionConfiguration
kmsKeyId
- Type: typing.Optional[str]
SessionData
name
- Type:
- Required: Yes
sessionArn
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
aiAgentConfiguration
- Type: typing.Optional[typing.Dict[typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE'], aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationData]]
description
- Type: typing.Optional[str]
integrationConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SessionIntegrationConfiguration]
tagFilter
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilterOutput]
tags
- Type: typing.Optional[typing.Dict[str, str]]
SessionIntegrationConfiguration
topicIntegrationArn
- Type: typing.Optional[str]
SessionSummary
assistantArn
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
sessionArn
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
SourceConfiguration
appIntegrations
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AppIntegrationsConfiguration]
managedSourceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ManagedSourceConfiguration]
SourceConfigurationOutput
appIntegrations
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AppIntegrationsConfigurationOutput]
managedSourceConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ManagedSourceConfigurationOutput]
SourceContentDataDetails
id
- Type:
- Required: Yes
rankingData
- Type:
- Required: Yes
textData
- Type:
- Required: Yes
type
- Type: typing.Literal['KNOWLEDGE_CONTENT']
- Required: Yes
citationSpan
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.CitationSpan]
StartContentUploadRequest
contentType
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
presignedUrlTimeToLive
- Type: typing.Optional[int]
StartContentUploadResponse
headersToInclude
- Type: typing.Dict[str, str]
- Required: Yes
uploadId
- Type:
- Required: Yes
url
- Type:
- Required: Yes
urlExpiry
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
StartImportJobRequest
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.qconnect.qconnect_classes.ExternalSourceConfiguration]
metadata
- Type: typing.Optional[typing.Dict[str, str]]
StartImportJobResponse
importJob
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
SystemAttributes
customerEndpoint
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SystemEndpointAttributes]
name
- Type: typing.Optional[str]
systemEndpoint
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SystemEndpointAttributes]
SystemEndpointAttributes
address
- Type: typing.Optional[str]
TagCondition
key
- Type:
- Required: Yes
value
- Type: typing.Optional[str]
TagFilter
andConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]]
orConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.OrCondition]]
tagCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]
TagFilterOutput
andConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]]
orConditions
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.OrConditionOutput]]
tagCondition
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagCondition]
TagResourceRequest
resourceArn
- Type:
- Required: Yes
tags
- Type: typing.Dict[str, str]
- Required: Yes
TextData
excerpt
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DocumentText]
title
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.DocumentText]
TextFullAIPromptEditTemplateConfiguration
text
- Type:
- Required: Yes
TextMessage
value
- Type: typing.Optional[str]
UntagResourceRequest
resourceArn
- Type:
- Required: Yes
tagKeys
- Type: typing.List[str]
- Required: Yes
UpdateAIAgentRequest
aiAgentId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
configuration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationOutput, NoneType]
description
- Type: typing.Optional[str]
UpdateAIAgentResponse
aiAgent
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateAIGuardrailRequest
aiGuardrailId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
blockedInputMessaging
- Type:
- Required: Yes
blockedOutputsMessaging
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
contentPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContentPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContentPolicyConfigOutput, NoneType]
contextualGroundingPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContextualGroundingPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailContextualGroundingPolicyConfigOutput, NoneType]
description
- Type: typing.Optional[str]
sensitiveInformationPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSensitiveInformationPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailSensitiveInformationPolicyConfigOutput, NoneType]
topicPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailTopicPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailTopicPolicyConfigOutput, NoneType]
wordPolicyConfig
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailWordPolicyConfig, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIGuardrailWordPolicyConfigOutput, NoneType]
UpdateAIGuardrailResponse
aiGuardrail
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateAIPromptRequest
aiPromptId
- Type:
- Required: Yes
assistantId
- Type:
- Required: Yes
visibilityStatus
- Type: typing.Literal['PUBLISHED', 'SAVED']
- Required: Yes
clientToken
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
templateConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIPromptTemplateConfiguration]
UpdateAIPromptResponse
aiPrompt
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateAssistantAIAgentRequest
aiAgentType
- Type: typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE']
- Required: Yes
assistantId
- Type:
- Required: Yes
configuration
- Type:
- Required: Yes
UpdateAssistantAIAgentResponse
assistant
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateContentRequest
contentId
- Type:
- Required: Yes
knowledgeBaseId
- Type:
- Required: Yes
metadata
- Type: typing.Optional[typing.Dict[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]
UpdateContentResponse
content
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateKnowledgeBaseTemplateUriRequest
knowledgeBaseId
- Type:
- Required: Yes
templateUri
- Type:
- Required: Yes
UpdateKnowledgeBaseTemplateUriResponse
knowledgeBase
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateMessageTemplateMetadataRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput, NoneType]
name
- Type: typing.Optional[str]
UpdateMessageTemplateMetadataResponse
messageTemplate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateMessageTemplateRequest
knowledgeBaseId
- Type:
- Required: Yes
messageTemplateId
- Type:
- Required: Yes
content
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateContentProvider, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateContentProviderOutput, NoneType]
defaultAttributes
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributes, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.MessageTemplateAttributesOutput, NoneType]
language
- Type: typing.Optional[str]
UpdateMessageTemplateResponse
messageTemplate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateQuickResponseRequest
knowledgeBaseId
- Type:
- Required: Yes
quickResponseId
- Type:
- Required: Yes
channels
- Type: typing.Optional[typing.List[str]]
content
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.QuickResponseDataProvider]
contentType
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
groupingConfiguration
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfiguration, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.GroupingConfigurationOutput, NoneType]
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]
UpdateQuickResponseResponse
quickResponse
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateSessionDataRequest
assistantId
- Type:
- Required: Yes
data
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RuntimeSessionData]
- Required: Yes
sessionId
- Type:
- Required: Yes
namespace
- Type: typing.Optional[typing.Literal['Custom']]
UpdateSessionDataResponse
data
- Type: typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.RuntimeSessionData]
- Required: Yes
namespace
- Type: typing.Literal['Custom']
- Required: Yes
sessionArn
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateSessionRequest
assistantId
- Type:
- Required: Yes
sessionId
- Type:
- Required: Yes
aiAgentConfiguration
- Type: typing.Optional[typing.Dict[typing.Literal['ANSWER_RECOMMENDATION', 'MANUAL_SEARCH', 'SELF_SERVICE'], aws_resource_validator.pydantic_models.qconnect.qconnect_classes.AIAgentConfigurationData]]
description
- Type: typing.Optional[str]
tagFilter
- Type: typing.Union[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilter, aws_resource_validator.pydantic_models.qconnect.qconnect_classes.TagFilterOutput, NoneType]
UpdateSessionResponse
session
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UrlConfiguration
seedUrls
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SeedUrl]]
UrlConfigurationOutput
seedUrls
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.SeedUrl]]
VectorIngestionConfiguration
chunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ChunkingConfiguration]
parsingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ParsingConfiguration]
VectorIngestionConfigurationOutput
chunkingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ChunkingConfigurationOutput]
parsingConfiguration
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.ParsingConfiguration]
WebCrawlerConfiguration
urlConfiguration
- Type:
- Required: Yes
crawlerLimits
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.WebCrawlerLimits]
exclusionFilters
- Type: typing.Optional[typing.List[str]]
inclusionFilters
- Type: typing.Optional[typing.List[str]]
scope
- Type: typing.Optional[typing.Literal['HOST_ONLY', 'SUBDOMAINS']]
WebCrawlerConfigurationOutput
urlConfiguration
- Type:
- Required: Yes
crawlerLimits
- Type: typing.Optional[aws_resource_validator.pydantic_models.qconnect.qconnect_classes.WebCrawlerLimits]
exclusionFilters
- Type: typing.Optional[typing.List[str]]
inclusionFilters
- Type: typing.Optional[typing.List[str]]
scope
- Type: typing.Optional[typing.Literal['HOST_ONLY', 'SUBDOMAINS']]
WebCrawlerLimits
rateLimit
- Type: typing.Optional[int]