# Amazon Q Connect
<a name="API_Types_Amazon_Q_Connect"></a>

The following data types are supported by Amazon Q Connect:
+  [AgentAttributes](API_amazon-q-connect_AgentAttributes.md) 
+  [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) 
+  [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) 
+  [AIAgentData](API_amazon-q-connect_AIAgentData.md) 
+  [AIAgentSummary](API_amazon-q-connect_AIAgentSummary.md) 
+  [AIAgentVersionSummary](API_amazon-q-connect_AIAgentVersionSummary.md) 
+  [AIGuardrailAssessment](API_amazon-q-connect_AIGuardrailAssessment.md) 
+  [AIGuardrailContentPolicyConfig](API_amazon-q-connect_AIGuardrailContentPolicyConfig.md) 
+  [AIGuardrailContextualGroundingPolicyConfig](API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig.md) 
+  [AIGuardrailData](API_amazon-q-connect_AIGuardrailData.md) 
+  [AIGuardrailSensitiveInformationPolicyConfig](API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig.md) 
+  [AIGuardrailSummary](API_amazon-q-connect_AIGuardrailSummary.md) 
+  [AIGuardrailTopicPolicyConfig](API_amazon-q-connect_AIGuardrailTopicPolicyConfig.md) 
+  [AIGuardrailVersionSummary](API_amazon-q-connect_AIGuardrailVersionSummary.md) 
+  [AIGuardrailWordPolicyConfig](API_amazon-q-connect_AIGuardrailWordPolicyConfig.md) 
+  [AIPromptData](API_amazon-q-connect_AIPromptData.md) 
+  [AIPromptInferenceConfiguration](API_amazon-q-connect_AIPromptInferenceConfiguration.md) 
+  [AIPromptSummary](API_amazon-q-connect_AIPromptSummary.md) 
+  [AIPromptTemplateConfiguration](API_amazon-q-connect_AIPromptTemplateConfiguration.md) 
+  [AIPromptVersionSummary](API_amazon-q-connect_AIPromptVersionSummary.md) 
+  [AmazonConnectGuideAssociationData](API_amazon-q-connect_AmazonConnectGuideAssociationData.md) 
+  [Annotation](API_amazon-q-connect_Annotation.md) 
+  [AnswerRecommendationAIAgentConfiguration](API_amazon-q-connect_AnswerRecommendationAIAgentConfiguration.md) 
+  [AppIntegrationsConfiguration](API_amazon-q-connect_AppIntegrationsConfiguration.md) 
+  [AssistantAssociationData](API_amazon-q-connect_AssistantAssociationData.md) 
+  [AssistantAssociationInputData](API_amazon-q-connect_AssistantAssociationInputData.md) 
+  [AssistantAssociationOutputData](API_amazon-q-connect_AssistantAssociationOutputData.md) 
+  [AssistantAssociationSummary](API_amazon-q-connect_AssistantAssociationSummary.md) 
+  [AssistantCapabilityConfiguration](API_amazon-q-connect_AssistantCapabilityConfiguration.md) 
+  [AssistantData](API_amazon-q-connect_AssistantData.md) 
+  [AssistantIntegrationConfiguration](API_amazon-q-connect_AssistantIntegrationConfiguration.md) 
+  [AssistantSummary](API_amazon-q-connect_AssistantSummary.md) 
+  [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) 
+  [AssociationConfigurationData](API_amazon-q-connect_AssociationConfigurationData.md) 
+  [BedrockFoundationModelConfigurationForParsing](API_amazon-q-connect_BedrockFoundationModelConfigurationForParsing.md) 
+  [CaseSummarizationAIAgentConfiguration](API_amazon-q-connect_CaseSummarizationAIAgentConfiguration.md) 
+  [CaseSummarizationChunkDataDetails](API_amazon-q-connect_CaseSummarizationChunkDataDetails.md) 
+  [CaseSummarizationInputData](API_amazon-q-connect_CaseSummarizationInputData.md) 
+  [ChunkingConfiguration](API_amazon-q-connect_ChunkingConfiguration.md) 
+  [Citation](API_amazon-q-connect_Citation.md) 
+  [CitationSpan](API_amazon-q-connect_CitationSpan.md) 
+  [Configuration](API_amazon-q-connect_Configuration.md) 
+  [ConnectConfiguration](API_amazon-q-connect_ConnectConfiguration.md) 
+  [ContentAssociationContents](API_amazon-q-connect_ContentAssociationContents.md) 
+  [ContentAssociationData](API_amazon-q-connect_ContentAssociationData.md) 
+  [ContentAssociationSummary](API_amazon-q-connect_ContentAssociationSummary.md) 
+  [ContentData](API_amazon-q-connect_ContentData.md) 
+  [ContentDataDetails](API_amazon-q-connect_ContentDataDetails.md) 
+  [ContentFeedbackData](API_amazon-q-connect_ContentFeedbackData.md) 
+  [ContentReference](API_amazon-q-connect_ContentReference.md) 
+  [ContentSummary](API_amazon-q-connect_ContentSummary.md) 
+  [ConversationContext](API_amazon-q-connect_ConversationContext.md) 
+  [ConversationState](API_amazon-q-connect_ConversationState.md) 
+  [CustomerProfileAttributes](API_amazon-q-connect_CustomerProfileAttributes.md) 
+  [DataDetails](API_amazon-q-connect_DataDetails.md) 
+  [DataReference](API_amazon-q-connect_DataReference.md) 
+  [DataSummary](API_amazon-q-connect_DataSummary.md) 
+  [Document](API_amazon-q-connect_Document.md) 
+  [DocumentText](API_amazon-q-connect_DocumentText.md) 
+  [EmailGenerativeAnswerAIAgentConfiguration](API_amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration.md) 
+  [EmailGenerativeAnswerChunkDataDetails](API_amazon-q-connect_EmailGenerativeAnswerChunkDataDetails.md) 
+  [EmailHeader](API_amazon-q-connect_EmailHeader.md) 
+  [EmailMessageTemplateContent](API_amazon-q-connect_EmailMessageTemplateContent.md) 
+  [EmailMessageTemplateContentBody](API_amazon-q-connect_EmailMessageTemplateContentBody.md) 
+  [EmailOverviewAIAgentConfiguration](API_amazon-q-connect_EmailOverviewAIAgentConfiguration.md) 
+  [EmailOverviewChunkDataDetails](API_amazon-q-connect_EmailOverviewChunkDataDetails.md) 
+  [EmailResponseAIAgentConfiguration](API_amazon-q-connect_EmailResponseAIAgentConfiguration.md) 
+  [EmailResponseChunkDataDetails](API_amazon-q-connect_EmailResponseChunkDataDetails.md) 
+  [ExtendedMessageTemplateData](API_amazon-q-connect_ExtendedMessageTemplateData.md) 
+  [ExternalBedrockKnowledgeBaseConfig](API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig.md) 
+  [ExternalSourceConfiguration](API_amazon-q-connect_ExternalSourceConfiguration.md) 
+  [Filter](API_amazon-q-connect_Filter.md) 
+  [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) 
+  [FixedSizeChunkingConfiguration](API_amazon-q-connect_FixedSizeChunkingConfiguration.md) 
+  [GenerativeChunkDataDetails](API_amazon-q-connect_GenerativeChunkDataDetails.md) 
+  [GenerativeContentFeedbackData](API_amazon-q-connect_GenerativeContentFeedbackData.md) 
+  [GenerativeDataDetails](API_amazon-q-connect_GenerativeDataDetails.md) 
+  [GenerativeReference](API_amazon-q-connect_GenerativeReference.md) 
+  [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) 
+  [GuardrailContentFilterConfig](API_amazon-q-connect_GuardrailContentFilterConfig.md) 
+  [GuardrailContextualGroundingFilterConfig](API_amazon-q-connect_GuardrailContextualGroundingFilterConfig.md) 
+  [GuardrailManagedWordsConfig](API_amazon-q-connect_GuardrailManagedWordsConfig.md) 
+  [GuardrailPiiEntityConfig](API_amazon-q-connect_GuardrailPiiEntityConfig.md) 
+  [GuardrailRegexConfig](API_amazon-q-connect_GuardrailRegexConfig.md) 
+  [GuardrailTopicConfig](API_amazon-q-connect_GuardrailTopicConfig.md) 
+  [GuardrailWordConfig](API_amazon-q-connect_GuardrailWordConfig.md) 
+  [HierarchicalChunkingConfiguration](API_amazon-q-connect_HierarchicalChunkingConfiguration.md) 
+  [HierarchicalChunkingLevelConfiguration](API_amazon-q-connect_HierarchicalChunkingLevelConfiguration.md) 
+  [Highlight](API_amazon-q-connect_Highlight.md) 
+  [ImportJobData](API_amazon-q-connect_ImportJobData.md) 
+  [ImportJobSummary](API_amazon-q-connect_ImportJobSummary.md) 
+  [IntentDetectedDataDetails](API_amazon-q-connect_IntentDetectedDataDetails.md) 
+  [IntentInputData](API_amazon-q-connect_IntentInputData.md) 
+  [KnowledgeBaseAssociationConfigurationData](API_amazon-q-connect_KnowledgeBaseAssociationConfigurationData.md) 
+  [KnowledgeBaseAssociationData](API_amazon-q-connect_KnowledgeBaseAssociationData.md) 
+  [KnowledgeBaseData](API_amazon-q-connect_KnowledgeBaseData.md) 
+  [KnowledgeBaseSummary](API_amazon-q-connect_KnowledgeBaseSummary.md) 
+  [KnowledgeSource](API_amazon-q-connect_KnowledgeSource.md) 
+  [ManagedSourceConfiguration](API_amazon-q-connect_ManagedSourceConfiguration.md) 
+  [ManualSearchAIAgentConfiguration](API_amazon-q-connect_ManualSearchAIAgentConfiguration.md) 
+  [MessageConfiguration](API_amazon-q-connect_MessageConfiguration.md) 
+  [MessageData](API_amazon-q-connect_MessageData.md) 
+  [MessageInput](API_amazon-q-connect_MessageInput.md) 
+  [MessageOutput](API_amazon-q-connect_MessageOutput.md) 
+  [MessageTemplateAttachment](API_amazon-q-connect_MessageTemplateAttachment.md) 
+  [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) 
+  [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) 
+  [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) 
+  [MessageTemplateData](API_amazon-q-connect_MessageTemplateData.md) 
+  [MessageTemplateFilterField](API_amazon-q-connect_MessageTemplateFilterField.md) 
+  [MessageTemplateOrderField](API_amazon-q-connect_MessageTemplateOrderField.md) 
+  [MessageTemplateQueryField](API_amazon-q-connect_MessageTemplateQueryField.md) 
+  [MessageTemplateSearchExpression](API_amazon-q-connect_MessageTemplateSearchExpression.md) 
+  [MessageTemplateSearchResultData](API_amazon-q-connect_MessageTemplateSearchResultData.md) 
+  [MessageTemplateSourceConfiguration](API_amazon-q-connect_MessageTemplateSourceConfiguration.md) 
+  [MessageTemplateSourceConfigurationSummary](API_amazon-q-connect_MessageTemplateSourceConfigurationSummary.md) 
+  [MessageTemplateSummary](API_amazon-q-connect_MessageTemplateSummary.md) 
+  [MessageTemplateVersionSummary](API_amazon-q-connect_MessageTemplateVersionSummary.md) 
+  [NotesChunkDataDetails](API_amazon-q-connect_NotesChunkDataDetails.md) 
+  [NotesDataDetails](API_amazon-q-connect_NotesDataDetails.md) 
+  [NoteTakingAIAgentConfiguration](API_amazon-q-connect_NoteTakingAIAgentConfiguration.md) 
+  [NotifyRecommendationsReceivedError](API_amazon-q-connect_NotifyRecommendationsReceivedError.md) 
+  [OrchestrationAIAgentConfiguration](API_amazon-q-connect_OrchestrationAIAgentConfiguration.md) 
+  [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) 
+  [OrCondition](API_amazon-q-connect_OrCondition.md) 
+  [ParsingConfiguration](API_amazon-q-connect_ParsingConfiguration.md) 
+  [ParsingPrompt](API_amazon-q-connect_ParsingPrompt.md) 
+  [PushADMMessageTemplateContent](API_amazon-q-connect_PushADMMessageTemplateContent.md) 
+  [PushAPNSMessageTemplateContent](API_amazon-q-connect_PushAPNSMessageTemplateContent.md) 
+  [PushBaiduMessageTemplateContent](API_amazon-q-connect_PushBaiduMessageTemplateContent.md) 
+  [PushFCMMessageTemplateContent](API_amazon-q-connect_PushFCMMessageTemplateContent.md) 
+  [PushMessageTemplateContent](API_amazon-q-connect_PushMessageTemplateContent.md) 
+  [QueryCondition](API_amazon-q-connect_QueryCondition.md) 
+  [QueryConditionItem](API_amazon-q-connect_QueryConditionItem.md) 
+  [QueryInputData](API_amazon-q-connect_QueryInputData.md) 
+  [QueryRecommendationTriggerData](API_amazon-q-connect_QueryRecommendationTriggerData.md) 
+  [QueryTextInputData](API_amazon-q-connect_QueryTextInputData.md) 
+  [QuickResponseContentProvider](API_amazon-q-connect_QuickResponseContentProvider.md) 
+  [QuickResponseContents](API_amazon-q-connect_QuickResponseContents.md) 
+  [QuickResponseData](API_amazon-q-connect_QuickResponseData.md) 
+  [QuickResponseDataProvider](API_amazon-q-connect_QuickResponseDataProvider.md) 
+  [QuickResponseFilterField](API_amazon-q-connect_QuickResponseFilterField.md) 
+  [QuickResponseOrderField](API_amazon-q-connect_QuickResponseOrderField.md) 
+  [QuickResponseQueryField](API_amazon-q-connect_QuickResponseQueryField.md) 
+  [QuickResponseSearchExpression](API_amazon-q-connect_QuickResponseSearchExpression.md) 
+  [QuickResponseSearchResultData](API_amazon-q-connect_QuickResponseSearchResultData.md) 
+  [QuickResponseSummary](API_amazon-q-connect_QuickResponseSummary.md) 
+  [RankingData](API_amazon-q-connect_RankingData.md) 
+  [RecommendationData](API_amazon-q-connect_RecommendationData.md) 
+  [RecommendationTrigger](API_amazon-q-connect_RecommendationTrigger.md) 
+  [RecommendationTriggerData](API_amazon-q-connect_RecommendationTriggerData.md) 
+  [RenderingConfiguration](API_amazon-q-connect_RenderingConfiguration.md) 
+  [ResultData](API_amazon-q-connect_ResultData.md) 
+  [RetrievalConfiguration](API_amazon-q-connect_RetrievalConfiguration.md) 
+  [RetrievalFilterConfiguration](API_amazon-q-connect_RetrievalFilterConfiguration.md) 
+  [RetrieveResult](API_amazon-q-connect_RetrieveResult.md) 
+  [RuntimeSessionData](API_amazon-q-connect_RuntimeSessionData.md) 
+  [RuntimeSessionDataValue](API_amazon-q-connect_RuntimeSessionDataValue.md) 
+  [SearchExpression](API_amazon-q-connect_SearchExpression.md) 
+  [SeedUrl](API_amazon-q-connect_SeedUrl.md) 
+  [SelfServiceAIAgentConfiguration](API_amazon-q-connect_SelfServiceAIAgentConfiguration.md) 
+  [SelfServiceConversationHistory](API_amazon-q-connect_SelfServiceConversationHistory.md) 
+  [SemanticChunkingConfiguration](API_amazon-q-connect_SemanticChunkingConfiguration.md) 
+  [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) 
+  [SessionData](API_amazon-q-connect_SessionData.md) 
+  [SessionIntegrationConfiguration](API_amazon-q-connect_SessionIntegrationConfiguration.md) 
+  [SessionSummary](API_amazon-q-connect_SessionSummary.md) 
+  [SMSMessageTemplateContent](API_amazon-q-connect_SMSMessageTemplateContent.md) 
+  [SMSMessageTemplateContentBody](API_amazon-q-connect_SMSMessageTemplateContentBody.md) 
+  [SourceConfiguration](API_amazon-q-connect_SourceConfiguration.md) 
+  [SourceContentDataDetails](API_amazon-q-connect_SourceContentDataDetails.md) 
+  [Span](API_amazon-q-connect_Span.md) 
+  [SpanAttributes](API_amazon-q-connect_SpanAttributes.md) 
+  [SpanCitation](API_amazon-q-connect_SpanCitation.md) 
+  [SpanMessage](API_amazon-q-connect_SpanMessage.md) 
+  [SpanMessageValue](API_amazon-q-connect_SpanMessageValue.md) 
+  [SpanTextValue](API_amazon-q-connect_SpanTextValue.md) 
+  [SpanToolResultValue](API_amazon-q-connect_SpanToolResultValue.md) 
+  [SpanToolUseValue](API_amazon-q-connect_SpanToolUseValue.md) 
+  [SuggestedMessageDataDetails](API_amazon-q-connect_SuggestedMessageDataDetails.md) 
+  [SuggestedMessageReference](API_amazon-q-connect_SuggestedMessageReference.md) 
+  [SystemAttributes](API_amazon-q-connect_SystemAttributes.md) 
+  [SystemEndpointAttributes](API_amazon-q-connect_SystemEndpointAttributes.md) 
+  [TagCondition](API_amazon-q-connect_TagCondition.md) 
+  [TagFilter](API_amazon-q-connect_TagFilter.md) 
+  [TextAIPromptInferenceConfiguration](API_amazon-q-connect_TextAIPromptInferenceConfiguration.md) 
+  [TextData](API_amazon-q-connect_TextData.md) 
+  [TextFullAIPromptEditTemplateConfiguration](API_amazon-q-connect_TextFullAIPromptEditTemplateConfiguration.md) 
+  [TextMessage](API_amazon-q-connect_TextMessage.md) 
+  [ToolConfiguration](API_amazon-q-connect_ToolConfiguration.md) 
+  [ToolInstruction](API_amazon-q-connect_ToolInstruction.md) 
+  [ToolOutputConfiguration](API_amazon-q-connect_ToolOutputConfiguration.md) 
+  [ToolOutputFilter](API_amazon-q-connect_ToolOutputFilter.md) 
+  [ToolOverrideConstantInputValue](API_amazon-q-connect_ToolOverrideConstantInputValue.md) 
+  [ToolOverrideInputValue](API_amazon-q-connect_ToolOverrideInputValue.md) 
+  [ToolOverrideInputValueConfiguration](API_amazon-q-connect_ToolOverrideInputValueConfiguration.md) 
+  [ToolUseResultData](API_amazon-q-connect_ToolUseResultData.md) 
+  [UrlConfiguration](API_amazon-q-connect_UrlConfiguration.md) 
+  [UserInteractionConfiguration](API_amazon-q-connect_UserInteractionConfiguration.md) 
+  [VectorIngestionConfiguration](API_amazon-q-connect_VectorIngestionConfiguration.md) 
+  [WebCrawlerConfiguration](API_amazon-q-connect_WebCrawlerConfiguration.md) 
+  [WebCrawlerLimits](API_amazon-q-connect_WebCrawlerLimits.md) 
+  [WhatsAppMessageTemplateContent](API_amazon-q-connect_WhatsAppMessageTemplateContent.md) 
+  [WhatsAppMessageTemplateSourceConfiguration](API_amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration.md) 
+  [WhatsAppMessageTemplateSourceConfigurationSummary](API_amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary.md) 

# AgentAttributes
<a name="API_amazon-q-connect_AgentAttributes"></a>

Information about an agent.

## Contents
<a name="API_amazon-q-connect_AgentAttributes_Contents"></a>

 ** firstName **   <a name="connect-Type-amazon-q-connect_AgentAttributes-firstName"></a>
The agent’s first name as entered in their Amazon Connect user account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** lastName **   <a name="connect-Type-amazon-q-connect_AgentAttributes-lastName"></a>
The agent’s last name as entered in their Amazon Connect user account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

## See Also
<a name="API_amazon-q-connect_AgentAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AgentAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AgentAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AgentAttributes) 

# AIAgentConfiguration
<a name="API_amazon-q-connect_AIAgentConfiguration"></a>

A typed union that specifies the configuration based on the type of AI Agent.

## Contents
<a name="API_amazon-q-connect_AIAgentConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** answerRecommendationAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-answerRecommendationAIAgentConfiguration"></a>
The configuration for AI Agents of type `ANSWER_RECOMMENDATION`.  
Type: [AnswerRecommendationAIAgentConfiguration](API_amazon-q-connect_AnswerRecommendationAIAgentConfiguration.md) object  
Required: No

 ** caseSummarizationAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-caseSummarizationAIAgentConfiguration"></a>
The configuration for AI Agents of type `CASE_SUMMARIZATION`.  
Type: [CaseSummarizationAIAgentConfiguration](API_amazon-q-connect_CaseSummarizationAIAgentConfiguration.md) object  
Required: No

 ** emailGenerativeAnswerAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-emailGenerativeAnswerAIAgentConfiguration"></a>
Configuration for the EMAIL\$1GENERATIVE\$1ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.  
Type: [EmailGenerativeAnswerAIAgentConfiguration](API_amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration.md) object  
Required: No

 ** emailOverviewAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-emailOverviewAIAgentConfiguration"></a>
Configuration for the EMAIL\$1OVERVIEW AI agent that generates structured overview of email conversations.  
Type: [EmailOverviewAIAgentConfiguration](API_amazon-q-connect_EmailOverviewAIAgentConfiguration.md) object  
Required: No

 ** emailResponseAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-emailResponseAIAgentConfiguration"></a>
Configuration for the EMAIL\$1RESPONSE AI agent that generates professional email responses using knowledge base content.  
Type: [EmailResponseAIAgentConfiguration](API_amazon-q-connect_EmailResponseAIAgentConfiguration.md) object  
Required: No

 ** manualSearchAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-manualSearchAIAgentConfiguration"></a>
The configuration for AI Agents of type `MANUAL_SEARCH`.  
Type: [ManualSearchAIAgentConfiguration](API_amazon-q-connect_ManualSearchAIAgentConfiguration.md) object  
Required: No

 ** noteTakingAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-noteTakingAIAgentConfiguration"></a>
The configuration for AI Agents of type `NOTE_TAKING`.  
Type: [NoteTakingAIAgentConfiguration](API_amazon-q-connect_NoteTakingAIAgentConfiguration.md) object  
Required: No

 ** orchestrationAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-orchestrationAIAgentConfiguration"></a>
The configuration for AI Agents of type `ORCHESTRATION`.  
Type: [OrchestrationAIAgentConfiguration](API_amazon-q-connect_OrchestrationAIAgentConfiguration.md) object  
Required: No

 ** selfServiceAIAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AIAgentConfiguration-selfServiceAIAgentConfiguration"></a>
The configuration for AI Agents of type SELF\$1SERVICE.  
Type: [SelfServiceAIAgentConfiguration](API_amazon-q-connect_SelfServiceAIAgentConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentConfiguration) 

# AIAgentConfigurationData
<a name="API_amazon-q-connect_AIAgentConfigurationData"></a>

A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

## Contents
<a name="API_amazon-q-connect_AIAgentConfigurationData_Contents"></a>

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_AIAgentConfigurationData-aiAgentId"></a>
The ID of the AI Agent to be configured.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_AIAgentConfigurationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentConfigurationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentConfigurationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentConfigurationData) 

# AIAgentData
<a name="API_amazon-q-connect_AIAgentData"></a>

The data for the AI Agent.

## Contents
<a name="API_amazon-q-connect_AIAgentData_Contents"></a>

 ** aiAgentArn **   <a name="connect-Type-amazon-q-connect_AIAgentData-aiAgentArn"></a>
The Amazon Resource Name (ARN) of the AI agent.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_AIAgentData-aiAgentId"></a>
The identifier of the AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIAgentData-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIAgentData-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** configuration **   <a name="connect-Type-amazon-q-connect_AIAgentData-configuration"></a>
Configuration for the AI Agent.  
Type: [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIAgentData-name"></a>
The name of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AIAgentData-type"></a>
The type of the AI Agent.  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIAgentData-visibilityStatus"></a>
The visibility status of the AI Agent.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIAgentData-description"></a>
The description of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIAgentData-modifiedTime"></a>
The time the AI Agent was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIAgentData-origin"></a>
Specifies the origin of the AI Agent. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.   
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIAgentData-status"></a>
The status of the AI Agent.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIAgentData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIAgentData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentData) 

# AIAgentSummary
<a name="API_amazon-q-connect_AIAgentSummary"></a>

The summary of the AI Agent.

## Contents
<a name="API_amazon-q-connect_AIAgentSummary_Contents"></a>

 ** aiAgentArn **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-aiAgentArn"></a>
The Amazon Resource Name (ARN) of the AI agent.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-aiAgentId"></a>
The identifier of the AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-name"></a>
The name of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-type"></a>
The type of the AI Agent.  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-visibilityStatus"></a>
The visibility status of the AI Agent.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** configuration **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-configuration"></a>
The configuration for the AI Agent.  
Type: [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-description"></a>
The description of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-modifiedTime"></a>
The time the AI Agent was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-origin"></a>
The origin of the AI Agent. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.  
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-status"></a>
The status of the AI Agent.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIAgentSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIAgentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentSummary) 

# AIAgentVersionSummary
<a name="API_amazon-q-connect_AIAgentVersionSummary"></a>

The summary of the AI Agent version.

## Contents
<a name="API_amazon-q-connect_AIAgentVersionSummary_Contents"></a>

 ** aiAgentSummary **   <a name="connect-Type-amazon-q-connect_AIAgentVersionSummary-aiAgentSummary"></a>
The data for the summary of the AI Agent version.  
Type: [AIAgentSummary](API_amazon-q-connect_AIAgentSummary.md) object  
Required: No

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_AIAgentVersionSummary-versionNumber"></a>
The version number for this AI Agent version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIAgentVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIAgentVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIAgentVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIAgentVersionSummary) 

# AIGuardrailAssessment
<a name="API_amazon-q-connect_AIGuardrailAssessment"></a>

The assessment information from the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_AIGuardrailAssessment_Contents"></a>

 ** blocked **   <a name="connect-Type-amazon-q-connect_AIGuardrailAssessment-blocked"></a>
Indicates whether the AI Guardrail blocked the content.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_amazon-q-connect_AIGuardrailAssessment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailAssessment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailAssessment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailAssessment) 

# AIGuardrailContentPolicyConfig
<a name="API_amazon-q-connect_AIGuardrailContentPolicyConfig"></a>

Contains details about how to handle harmful content.

## Contents
<a name="API_amazon-q-connect_AIGuardrailContentPolicyConfig_Contents"></a>

 ** filtersConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailContentPolicyConfig-filtersConfig"></a>
Contains the type of the content filter and how strongly it should apply to prompts and model responses.  
Type: Array of [GuardrailContentFilterConfig](API_amazon-q-connect_GuardrailContentFilterConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_AIGuardrailContentPolicyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailContentPolicyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailContentPolicyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailContentPolicyConfig) 

# AIGuardrailContextualGroundingPolicyConfig
<a name="API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig"></a>

The policy configuration details for the AI Guardrail's contextual grounding policy.

## Contents
<a name="API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig_Contents"></a>

 ** filtersConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig-filtersConfig"></a>
The filter configuration details for the AI Guardrails contextual grounding policy.  
Type: Array of [GuardrailContextualGroundingFilterConfig](API_amazon-q-connect_GuardrailContextualGroundingFilterConfig.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailContextualGroundingPolicyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailContextualGroundingPolicyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailContextualGroundingPolicyConfig) 

# AIGuardrailData
<a name="API_amazon-q-connect_AIGuardrailData"></a>

The data for the AI Guardrail

## Contents
<a name="API_amazon-q-connect_AIGuardrailData_Contents"></a>

 ** aiGuardrailArn **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-aiGuardrailArn"></a>
The Amazon Resource Name (ARN) of the AI Guardrail.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiGuardrailId **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** blockedInputMessaging **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-blockedInputMessaging"></a>
The message to return when the AI Guardrail blocks a prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** blockedOutputsMessaging **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-blockedOutputsMessaging"></a>
The message to return when the AI Guardrail blocks a model response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-name"></a>
The name of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-visibilityStatus"></a>
The visibility status of the AI Guardrail.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** contentPolicyConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-contentPolicyConfig"></a>
Contains details about how to handle harmful content.  
Type: [AIGuardrailContentPolicyConfig](API_amazon-q-connect_AIGuardrailContentPolicyConfig.md) object  
Required: No

 ** contextualGroundingPolicyConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-contextualGroundingPolicyConfig"></a>
The policy configuration details for the AI Guardrail's contextual grounding policy.  
Type: [AIGuardrailContextualGroundingPolicyConfig](API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-description"></a>
A description of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-modifiedTime"></a>
The time the AI Guardrail was last modified.  
Type: Timestamp  
Required: No

 ** sensitiveInformationPolicyConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-sensitiveInformationPolicyConfig"></a>
Contains details about PII entities and regular expressions to configure for the AI Guardrail.  
Type: [AIGuardrailSensitiveInformationPolicyConfig](API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig.md) object  
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-status"></a>
The status of the AI Guardrail.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** topicPolicyConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-topicPolicyConfig"></a>
Contains details about topics that the AI Guardrail should identify and deny.  
Type: [AIGuardrailTopicPolicyConfig](API_amazon-q-connect_AIGuardrailTopicPolicyConfig.md) object  
Required: No

 ** wordPolicyConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailData-wordPolicyConfig"></a>
Contains details about the word policy to configured for the AI Guardrail.  
Type: [AIGuardrailWordPolicyConfig](API_amazon-q-connect_AIGuardrailWordPolicyConfig.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AIGuardrailData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailData) 

# AIGuardrailSensitiveInformationPolicyConfig
<a name="API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig"></a>

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig_Contents"></a>

 ** piiEntitiesConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig-piiEntitiesConfig"></a>
A list of PII entities to configure to the AI Guardrail.  
Type: Array of [GuardrailPiiEntityConfig](API_amazon-q-connect_GuardrailPiiEntityConfig.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** regexesConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig-regexesConfig"></a>
A list of regular expressions to configure to the AI Guardrail.  
Type: Array of [GuardrailRegexConfig](API_amazon-q-connect_GuardrailRegexConfig.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailSensitiveInformationPolicyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailSensitiveInformationPolicyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailSensitiveInformationPolicyConfig) 

# AIGuardrailSummary
<a name="API_amazon-q-connect_AIGuardrailSummary"></a>

The summary of the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_AIGuardrailSummary_Contents"></a>

 ** aiGuardrailArn **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-aiGuardrailArn"></a>
The Amazon Resource Name (ARN) of the AI Guardrail.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiGuardrailId **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-name"></a>
The name of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-visibilityStatus"></a>
The visibility status of the AI Guardrail.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-description"></a>
A description of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-modifiedTime"></a>
The time the AI Guardrail was last modified.  
Type: Timestamp  
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-status"></a>
The status of the AI Guardrail.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIGuardrailSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIGuardrailSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailSummary) 

# AIGuardrailTopicPolicyConfig
<a name="API_amazon-q-connect_AIGuardrailTopicPolicyConfig"></a>

Contains details about topics that the AI Guardrail should identify and deny.

## Contents
<a name="API_amazon-q-connect_AIGuardrailTopicPolicyConfig_Contents"></a>

 ** topicsConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailTopicPolicyConfig-topicsConfig"></a>
A list of policies related to topics that the AI Guardrail should deny.  
Type: Array of [GuardrailTopicConfig](API_amazon-q-connect_GuardrailTopicConfig.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_AIGuardrailTopicPolicyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailTopicPolicyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailTopicPolicyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailTopicPolicyConfig) 

# AIGuardrailVersionSummary
<a name="API_amazon-q-connect_AIGuardrailVersionSummary"></a>

The summary of the AI Guardrail version.

## Contents
<a name="API_amazon-q-connect_AIGuardrailVersionSummary_Contents"></a>

 ** aiGuardrailSummary **   <a name="connect-Type-amazon-q-connect_AIGuardrailVersionSummary-aiGuardrailSummary"></a>
The data for the summary of the AI Guardrail version.  
Type: [AIGuardrailSummary](API_amazon-q-connect_AIGuardrailSummary.md) object  
Required: No

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_AIGuardrailVersionSummary-versionNumber"></a>
The version number for this AI Guardrail version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIGuardrailVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailVersionSummary) 

# AIGuardrailWordPolicyConfig
<a name="API_amazon-q-connect_AIGuardrailWordPolicyConfig"></a>

Contains details about the word policy to configured for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_AIGuardrailWordPolicyConfig_Contents"></a>

 ** managedWordListsConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailWordPolicyConfig-managedWordListsConfig"></a>
A list of managed words to configure for the AI Guardrail.  
Type: Array of [GuardrailManagedWordsConfig](API_amazon-q-connect_GuardrailManagedWordsConfig.md) objects  
Required: No

 ** wordsConfig **   <a name="connect-Type-amazon-q-connect_AIGuardrailWordPolicyConfig-wordsConfig"></a>
A list of words to configure for the AI Guardrail.  
Type: Array of [GuardrailWordConfig](API_amazon-q-connect_GuardrailWordConfig.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIGuardrailWordPolicyConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIGuardrailWordPolicyConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIGuardrailWordPolicyConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIGuardrailWordPolicyConfig) 

# AIPromptData
<a name="API_amazon-q-connect_AIPromptData"></a>

The data for the AI Prompt

## Contents
<a name="API_amazon-q-connect_AIPromptData_Contents"></a>

 ** aiPromptArn **   <a name="connect-Type-amazon-q-connect_AIPromptData-aiPromptArn"></a>
The Amazon Resource Name (ARN) of the AI Prompt.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiPromptId **   <a name="connect-Type-amazon-q-connect_AIPromptData-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** apiFormat **   <a name="connect-Type-amazon-q-connect_AIPromptData-apiFormat"></a>
The API format used for this AI Prompt.  
Type: String  
Valid Values: `ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS | MESSAGES | TEXT_COMPLETIONS`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIPromptData-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIPromptData-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** modelId **   <a name="connect-Type-amazon-q-connect_AIPromptData-modelId"></a>
The identifier of the model used for this AI Prompt. The following model Ids are supported:  
+  `anthropic.claude-3-haiku--v1:0` 
+  `apac.amazon.nova-lite-v1:0` 
+  `apac.amazon.nova-micro-v1:0` 
+  `apac.amazon.nova-pro-v1:0` 
+  `apac.anthropic.claude-3-5-sonnet--v2:0` 
+  `apac.anthropic.claude-3-haiku-20240307-v1:0` 
+  `eu.amazon.nova-lite-v1:0` 
+  `eu.amazon.nova-micro-v1:0` 
+  `eu.amazon.nova-pro-v1:0` 
+  `eu.anthropic.claude-3-7-sonnet-20250219-v1:0` 
+  `eu.anthropic.claude-3-haiku-20240307-v1:0` 
+  `us.amazon.nova-lite-v1:0` 
+  `us.amazon.nova-micro-v1:0` 
+  `us.amazon.nova-pro-v1:0` 
+  `us.anthropic.claude-3-5-haiku-20241022-v1:0` 
+  `us.anthropic.claude-3-7-sonnet-20250219-v1:0` 
+  `us.anthropic.claude-3-haiku-20240307-v1:0` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIPromptData-name"></a>
The name of the AI Prompt  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** templateConfiguration **   <a name="connect-Type-amazon-q-connect_AIPromptData-templateConfiguration"></a>
The configuration of the prompt template for this AI Prompt.  
Type: [AIPromptTemplateConfiguration](API_amazon-q-connect_AIPromptTemplateConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** templateType **   <a name="connect-Type-amazon-q-connect_AIPromptData-templateType"></a>
The type of the prompt template for this AI Prompt.  
Type: String  
Valid Values: `TEXT`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AIPromptData-type"></a>
The type of this AI Prompt.  
Type: String  
Valid Values: `ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIPromptData-visibilityStatus"></a>
The visibility status of the AI Prompt.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIPromptData-description"></a>
The description of the AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** inferenceConfiguration **   <a name="connect-Type-amazon-q-connect_AIPromptData-inferenceConfiguration"></a>
The configuration for inference parameters when using the AI Prompt.  
Type: [AIPromptInferenceConfiguration](API_amazon-q-connect_AIPromptInferenceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIPromptData-modifiedTime"></a>
The time the AI Prompt was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIPromptData-origin"></a>
The origin of the AI Prompt. `SYSTEM` for a default AI Prompt created by Q in Connect or `CUSTOMER` for an AI Prompt created by calling AI Prompt creation APIs.   
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIPromptData-status"></a>
The status of the AI Prompt.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIPromptData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIPromptData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptData) 

# AIPromptInferenceConfiguration
<a name="API_amazon-q-connect_AIPromptInferenceConfiguration"></a>

The configuration for inference parameters when using AI Prompts.

## Contents
<a name="API_amazon-q-connect_AIPromptInferenceConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** textAIPromptInferenceConfiguration **   <a name="connect-Type-amazon-q-connect_AIPromptInferenceConfiguration-textAIPromptInferenceConfiguration"></a>
The inference configuration for text-based AI Prompts.  
Type: [TextAIPromptInferenceConfiguration](API_amazon-q-connect_TextAIPromptInferenceConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AIPromptInferenceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptInferenceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptInferenceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptInferenceConfiguration) 

# AIPromptSummary
<a name="API_amazon-q-connect_AIPromptSummary"></a>

The summary of the AI Prompt.

## Contents
<a name="API_amazon-q-connect_AIPromptSummary_Contents"></a>

 ** aiPromptArn **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-aiPromptArn"></a>
The Amazon Resource Name (ARN) of the AI Prompt.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiPromptId **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** apiFormat **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-apiFormat"></a>
The API format used for this AI Prompt.  
Type: String  
Valid Values: `ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS | MESSAGES | TEXT_COMPLETIONS`   
Required: Yes

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** modelId **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-modelId"></a>
The identifier of the model used for this AI Prompt. Model Ids supported are: `anthropic.claude-3-haiku-20240307-v1:0`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-name"></a>
The name of the AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** templateType **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-templateType"></a>
The type of the prompt template for this AI Prompt.  
Type: String  
Valid Values: `TEXT`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-type"></a>
The type of this AI Prompt.  
Type: String  
Valid Values: `ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** visibilityStatus **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-visibilityStatus"></a>
The visibility status of the AI Prompt.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-description"></a>
The description of the AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** modifiedTime **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-modifiedTime"></a>
The time the AI Prompt was last modified.  
Type: Timestamp  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-origin"></a>
The origin of the AI Prompt. `SYSTEM` for a default AI Prompt created by Q in Connect or `CUSTOMER` for an AI Prompt created by calling AI Prompt creation APIs.   
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-status"></a>
The status of the AI Prompt.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AIPromptSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIPromptSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptSummary) 

# AIPromptTemplateConfiguration
<a name="API_amazon-q-connect_AIPromptTemplateConfiguration"></a>

A typed union that specifies the configuration for a prompt template based on its type.

## Contents
<a name="API_amazon-q-connect_AIPromptTemplateConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** textFullAIPromptEditTemplateConfiguration **   <a name="connect-Type-amazon-q-connect_AIPromptTemplateConfiguration-textFullAIPromptEditTemplateConfiguration"></a>
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.  
Type: [TextFullAIPromptEditTemplateConfiguration](API_amazon-q-connect_TextFullAIPromptEditTemplateConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AIPromptTemplateConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptTemplateConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptTemplateConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptTemplateConfiguration) 

# AIPromptVersionSummary
<a name="API_amazon-q-connect_AIPromptVersionSummary"></a>

The summary of the AI Prompt version.

## Contents
<a name="API_amazon-q-connect_AIPromptVersionSummary_Contents"></a>

 ** aiPromptSummary **   <a name="connect-Type-amazon-q-connect_AIPromptVersionSummary-aiPromptSummary"></a>
The date for the summary of the AI Prompt version.  
Type: [AIPromptSummary](API_amazon-q-connect_AIPromptSummary.md) object  
Required: No

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_AIPromptVersionSummary-versionNumber"></a>
The version number for this AI Prompt version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_AIPromptVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AIPromptVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AIPromptVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AIPromptVersionSummary) 

# AmazonConnectGuideAssociationData
<a name="API_amazon-q-connect_AmazonConnectGuideAssociationData"></a>

Content association data for a [step-by-step guide](https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html).

## Contents
<a name="API_amazon-q-connect_AmazonConnectGuideAssociationData_Contents"></a>

 ** flowId **   <a name="connect-Type-amazon-q-connect_AmazonConnectGuideAssociationData-flowId"></a>
 The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

## See Also
<a name="API_amazon-q-connect_AmazonConnectGuideAssociationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AmazonConnectGuideAssociationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AmazonConnectGuideAssociationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AmazonConnectGuideAssociationData) 

# Annotation
<a name="API_amazon-q-connect_Annotation"></a>

An annotation that provides additional context or metadata.

## Contents
<a name="API_amazon-q-connect_Annotation_Contents"></a>

 ** destructiveHint **   <a name="connect-Type-amazon-q-connect_Annotation-destructiveHint"></a>
A hint indicating that the annotation contains potentially destructive content.  
Type: Boolean  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_Annotation-title"></a>
The title of the annotation.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_Annotation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Annotation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Annotation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Annotation) 

# AnswerRecommendationAIAgentConfiguration
<a name="API_amazon-q-connect_AnswerRecommendationAIAgentConfiguration"></a>

The configuration for the `ANSWER_RECOMMENDATION` AI Agent type.

## Contents
<a name="API_amazon-q-connect_AnswerRecommendationAIAgentConfiguration_Contents"></a>

 ** answerGenerationAIGuardrailId **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-answerGenerationAIGuardrailId"></a>
The AI Guardrail identifier for the Answer Generation Guardrail used by the `ANSWER_RECOMMENDATION` AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** answerGenerationAIPromptId **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-answerGenerationAIPromptId"></a>
The AI Prompt identifier for the Answer Generation prompt used by the `ANSWER_RECOMMENDATION` AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** associationConfigurations **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-associationConfigurations"></a>
The association configurations for overriding behavior on this AI Agent.  
Type: Array of [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) objects  
Required: No

 ** intentLabelingGenerationAIPromptId **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-intentLabelingGenerationAIPromptId"></a>
The AI Prompt identifier for the Intent Labeling prompt used by the `ANSWER_RECOMMENDATION` AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-locale"></a>
The locale to which specifies the language and region settings that determine the response language for [QueryAssistant](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html).  
For more information on supported locales, see [Language support for Amazon Q in Connect](https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** queryReformulationAIPromptId **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-queryReformulationAIPromptId"></a>
The AI Prompt identifier for the Query Reformulation prompt used by the `ANSWER_RECOMMENDATION` AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** suggestedMessages **   <a name="connect-Type-amazon-q-connect_AnswerRecommendationAIAgentConfiguration-suggestedMessages"></a>
The suggested messages configuration for the Answer Recommendation AI Agent.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_AnswerRecommendationAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration) 

# AppIntegrationsConfiguration
<a name="API_amazon-q-connect_AppIntegrationsConfiguration"></a>

Configuration information for Amazon AppIntegrations to automatically ingest content.

## Contents
<a name="API_amazon-q-connect_AppIntegrationsConfiguration_Contents"></a>

 ** appIntegrationArn **   <a name="connect-Type-amazon-q-connect_AppIntegrationsConfiguration-appIntegrationArn"></a>
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.  
+  For [ Salesforce](https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm), your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least `Id`, `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, and `IsDeleted` as source fields. 
+  For [ ServiceNow](https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api), your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least `number`, `short_description`, `sys_mod_count`, `workflow_state`, and `active` as source fields. 
+  For [ Zendesk](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/), your AppIntegrations DataIntegration must have an ObjectConfiguration if `objectFields` is not provided, including at least `id`, `title`, `updated_at`, and `draft` as source fields. 
+  For [SharePoint](https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index), your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among `docx`, `pdf`, `html`, `htm`, and `txt`. 
+  For [Amazon S3](http://aws.amazon.com/s3/), the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The `SourceURI` of your DataIntegration must use the following format: `s3://your_s3_bucket_name`.
**Important**  
The bucket policy of the corresponding S3 bucket must allow the AWS principal `app-integrations.amazonaws.com` to perform `s3:ListBucket`, `s3:GetObject`, and `s3:GetBucketLocation` against the bucket.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: Yes

 ** objectFields **   <a name="connect-Type-amazon-q-connect_AppIntegrationsConfiguration-objectFields"></a>
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.   
+  For [ Salesforce](https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm), you must include at least `Id`, `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, and `IsDeleted`. 
+ For [ ServiceNow](https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api), you must include at least `number`, `short_description`, `sys_mod_count`, `workflow_state`, and `active`. 
+ For [ Zendesk](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/), you must include at least `id`, `title`, `updated_at`, and `draft`. 
Make sure to include additional fields. These fields are indexed and used to source recommendations.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_AppIntegrationsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AppIntegrationsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AppIntegrationsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AppIntegrationsConfiguration) 

# AssistantAssociationData
<a name="API_amazon-q-connect_AssistantAssociationData"></a>

Information about the assistant association.

## Contents
<a name="API_amazon-q-connect_AssistantAssociationData_Contents"></a>

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantAssociationArn **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-assistantAssociationArn"></a>
The Amazon Resource Name (ARN) of the assistant association.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantAssociationId **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-assistantAssociationId"></a>
The identifier of the assistant association.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** associationData **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-associationData"></a>
A union type that currently has a single argument, the knowledge base ID.  
Type: [AssistantAssociationOutputData](API_amazon-q-connect_AssistantAssociationOutputData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** associationType **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-associationType"></a>
The type of association.  
Type: String  
Valid Values: `KNOWLEDGE_BASE | EXTERNAL_BEDROCK_KNOWLEDGE_BASE`   
Required: Yes

 ** tags **   <a name="connect-Type-amazon-q-connect_AssistantAssociationData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantAssociationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantAssociationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantAssociationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantAssociationData) 

# AssistantAssociationInputData
<a name="API_amazon-q-connect_AssistantAssociationInputData"></a>

The data that is input into Amazon Q in Connect as a result of the assistant association.

## Contents
<a name="API_amazon-q-connect_AssistantAssociationInputData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** externalBedrockKnowledgeBaseConfig **   <a name="connect-Type-amazon-q-connect_AssistantAssociationInputData-externalBedrockKnowledgeBaseConfig"></a>
The configuration for an external Bedrock knowledge base association.  
Type: [ExternalBedrockKnowledgeBaseConfig](API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig.md) object  
Required: No

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_AssistantAssociationInputData-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantAssociationInputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantAssociationInputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantAssociationInputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantAssociationInputData) 

# AssistantAssociationOutputData
<a name="API_amazon-q-connect_AssistantAssociationOutputData"></a>

The data that is output as a result of the assistant association.

## Contents
<a name="API_amazon-q-connect_AssistantAssociationOutputData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** externalBedrockKnowledgeBaseConfig **   <a name="connect-Type-amazon-q-connect_AssistantAssociationOutputData-externalBedrockKnowledgeBaseConfig"></a>
The configuration for an external Bedrock knowledge base association in the output data.  
Type: [ExternalBedrockKnowledgeBaseConfig](API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig.md) object  
Required: No

 ** knowledgeBaseAssociation **   <a name="connect-Type-amazon-q-connect_AssistantAssociationOutputData-knowledgeBaseAssociation"></a>
The knowledge base where output data is sent.  
Type: [KnowledgeBaseAssociationData](API_amazon-q-connect_KnowledgeBaseAssociationData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantAssociationOutputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantAssociationOutputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantAssociationOutputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantAssociationOutputData) 

# AssistantAssociationSummary
<a name="API_amazon-q-connect_AssistantAssociationSummary"></a>

Summary information about the assistant association.

## Contents
<a name="API_amazon-q-connect_AssistantAssociationSummary_Contents"></a>

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantAssociationArn **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-assistantAssociationArn"></a>
The Amazon Resource Name (ARN) of the assistant association.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantAssociationId **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-assistantAssociationId"></a>
The identifier of the assistant association.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** associationData **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-associationData"></a>
The association data.  
Type: [AssistantAssociationOutputData](API_amazon-q-connect_AssistantAssociationOutputData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** associationType **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-associationType"></a>
The type of association.  
Type: String  
Valid Values: `KNOWLEDGE_BASE | EXTERNAL_BEDROCK_KNOWLEDGE_BASE`   
Required: Yes

 ** tags **   <a name="connect-Type-amazon-q-connect_AssistantAssociationSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantAssociationSummary) 

# AssistantCapabilityConfiguration
<a name="API_amazon-q-connect_AssistantCapabilityConfiguration"></a>

The capability configuration for an Amazon Q in Connect assistant. 

## Contents
<a name="API_amazon-q-connect_AssistantCapabilityConfiguration_Contents"></a>

 ** type **   <a name="connect-Type-amazon-q-connect_AssistantCapabilityConfiguration-type"></a>
The type of Amazon Q in Connect assistant capability.   
Type: String  
Valid Values: `V1 | V2`   
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantCapabilityConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantCapabilityConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantCapabilityConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantCapabilityConfiguration) 

# AssistantData
<a name="API_amazon-q-connect_AssistantData"></a>

The assistant data.

## Contents
<a name="API_amazon-q-connect_AssistantData_Contents"></a>

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AssistantData-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AssistantData-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AssistantData-name"></a>
The name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_AssistantData-status"></a>
The status of the assistant.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AssistantData-type"></a>
The type of assistant.  
Type: String  
Valid Values: `AGENT`   
Required: Yes

 ** aiAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantData-aiAgentConfiguration"></a>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.  
Type: String to [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object map  
Valid Keys: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** capabilityConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantData-capabilityConfiguration"></a>
The configuration information for the Amazon Q in Connect assistant capability.   
Type: [AssistantCapabilityConfiguration](API_amazon-q-connect_AssistantCapabilityConfiguration.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_AssistantData-description"></a>
The description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** integrationConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantData-integrationConfiguration"></a>
The configuration information for the Amazon Q in Connect assistant integration.  
Type: [AssistantIntegrationConfiguration](API_amazon-q-connect_AssistantIntegrationConfiguration.md) object  
Required: No

 ** orchestratorConfigurationList **   <a name="connect-Type-amazon-q-connect_AssistantData-orchestratorConfigurationList"></a>
The list of orchestrator configurations for the assistant.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

 ** serverSideEncryptionConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantData-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
This KMS key must have a policy that allows `kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the `connect.amazonaws.com` service principal.   
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AssistantData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantData) 

# AssistantIntegrationConfiguration
<a name="API_amazon-q-connect_AssistantIntegrationConfiguration"></a>

The configuration information for the Amazon Q in Connect assistant integration.

## Contents
<a name="API_amazon-q-connect_AssistantIntegrationConfiguration_Contents"></a>

 ** topicIntegrationArn **   <a name="connect-Type-amazon-q-connect_AssistantIntegrationConfiguration-topicIntegrationArn"></a>
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantIntegrationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantIntegrationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantIntegrationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantIntegrationConfiguration) 

# AssistantSummary
<a name="API_amazon-q-connect_AssistantSummary"></a>

Summary information about the assistant.

## Contents
<a name="API_amazon-q-connect_AssistantSummary_Contents"></a>

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_AssistantSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_AssistantSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_AssistantSummary-name"></a>
The name of the assistant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_AssistantSummary-status"></a>
The status of the assistant.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_AssistantSummary-type"></a>
The type of the assistant.  
Type: String  
Valid Values: `AGENT`   
Required: Yes

 ** aiAgentConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantSummary-aiAgentConfiguration"></a>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.  
Type: String to [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object map  
Valid Keys: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** capabilityConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantSummary-capabilityConfiguration"></a>
The configuration information for the Amazon Q in Connect assistant capability.   
Type: [AssistantCapabilityConfiguration](API_amazon-q-connect_AssistantCapabilityConfiguration.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_AssistantSummary-description"></a>
The description of the assistant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** integrationConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantSummary-integrationConfiguration"></a>
The configuration information for the Amazon Q in Connect assistant integration.  
Type: [AssistantIntegrationConfiguration](API_amazon-q-connect_AssistantIntegrationConfiguration.md) object  
Required: No

 ** orchestratorConfigurationList **   <a name="connect-Type-amazon-q-connect_AssistantSummary-orchestratorConfigurationList"></a>
The list of orchestrator configurations for the assistant.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

 ** serverSideEncryptionConfiguration **   <a name="connect-Type-amazon-q-connect_AssistantSummary-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
This KMS key must have a policy that allows `kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the `connect.amazonaws.com` service principal.   
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_AssistantSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_AssistantSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssistantSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssistantSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssistantSummary) 

# AssociationConfiguration
<a name="API_amazon-q-connect_AssociationConfiguration"></a>

The configuration for an Amazon Q in Connect Assistant Association.

## Contents
<a name="API_amazon-q-connect_AssociationConfiguration_Contents"></a>

 ** associationConfigurationData **   <a name="connect-Type-amazon-q-connect_AssociationConfiguration-associationConfigurationData"></a>
The data of the configuration for an Amazon Q in Connect Assistant Association.  
Type: [AssociationConfigurationData](API_amazon-q-connect_AssociationConfigurationData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** associationId **   <a name="connect-Type-amazon-q-connect_AssociationConfiguration-associationId"></a>
The identifier of the association for this Association Configuration.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** associationType **   <a name="connect-Type-amazon-q-connect_AssociationConfiguration-associationType"></a>
The type of the association for this Association Configuration.  
Type: String  
Valid Values: `KNOWLEDGE_BASE`   
Required: No

## See Also
<a name="API_amazon-q-connect_AssociationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssociationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssociationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssociationConfiguration) 

# AssociationConfigurationData
<a name="API_amazon-q-connect_AssociationConfigurationData"></a>

A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.

## Contents
<a name="API_amazon-q-connect_AssociationConfigurationData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** knowledgeBaseAssociationConfigurationData **   <a name="connect-Type-amazon-q-connect_AssociationConfigurationData-knowledgeBaseAssociationConfigurationData"></a>
The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q in Connect Assistant Association.  
Type: [KnowledgeBaseAssociationConfigurationData](API_amazon-q-connect_KnowledgeBaseAssociationConfigurationData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_AssociationConfigurationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/AssociationConfigurationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/AssociationConfigurationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/AssociationConfigurationData) 

# BedrockFoundationModelConfigurationForParsing
<a name="API_amazon-q-connect_BedrockFoundationModelConfigurationForParsing"></a>

Settings for a foundation model used to parse documents for a data source.

## Contents
<a name="API_amazon-q-connect_BedrockFoundationModelConfigurationForParsing_Contents"></a>

 ** modelArn **   <a name="connect-Type-amazon-q-connect_BedrockFoundationModelConfigurationForParsing-modelArn"></a>
The ARN of the foundation model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/anthropic.claude-3-haiku-20240307-v1:0`   
Required: Yes

 ** parsingPrompt **   <a name="connect-Type-amazon-q-connect_BedrockFoundationModelConfigurationForParsing-parsingPrompt"></a>
Instructions for interpreting the contents of a document.  
Type: [ParsingPrompt](API_amazon-q-connect_ParsingPrompt.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_BedrockFoundationModelConfigurationForParsing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/BedrockFoundationModelConfigurationForParsing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/BedrockFoundationModelConfigurationForParsing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/BedrockFoundationModelConfigurationForParsing) 

# CaseSummarizationAIAgentConfiguration
<a name="API_amazon-q-connect_CaseSummarizationAIAgentConfiguration"></a>

The configuration for AI Agents of type `CASE_SUMMARIZATION`.

## Contents
<a name="API_amazon-q-connect_CaseSummarizationAIAgentConfiguration_Contents"></a>

 ** caseSummarizationAIGuardrailId **   <a name="connect-Type-amazon-q-connect_CaseSummarizationAIAgentConfiguration-caseSummarizationAIGuardrailId"></a>
The AI Guardrail identifier used by the Case Summarization AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** caseSummarizationAIPromptId **   <a name="connect-Type-amazon-q-connect_CaseSummarizationAIAgentConfiguration-caseSummarizationAIPromptId"></a>
The AI Prompt identifier used by the Case Summarization AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_CaseSummarizationAIAgentConfiguration-locale"></a>
The locale setting for the Case Summarization AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_CaseSummarizationAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CaseSummarizationAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CaseSummarizationAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CaseSummarizationAIAgentConfiguration) 

# CaseSummarizationChunkDataDetails
<a name="API_amazon-q-connect_CaseSummarizationChunkDataDetails"></a>

Details about case summarization chunk data.

## Contents
<a name="API_amazon-q-connect_CaseSummarizationChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_CaseSummarizationChunkDataDetails-completion"></a>
A chunk of the case summarization completion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_CaseSummarizationChunkDataDetails-nextChunkToken"></a>
Token for retrieving the next chunk of streaming summarization data, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_CaseSummarizationChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CaseSummarizationChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CaseSummarizationChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CaseSummarizationChunkDataDetails) 

# CaseSummarizationInputData
<a name="API_amazon-q-connect_CaseSummarizationInputData"></a>

Input data for case summarization.

## Contents
<a name="API_amazon-q-connect_CaseSummarizationInputData_Contents"></a>

 ** caseArn **   <a name="connect-Type-amazon-q-connect_CaseSummarizationInputData-caseArn"></a>
The Amazon Resource Name (ARN) of the case for summarization.  
Type: String  
Pattern: `arn:[a-z-]*?:cases:[a-z0-9-]*?:[0-9]{12}:domain/.{1,500}/case/[A-Za-z0-9\-._/:#=+-]{1,500}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_CaseSummarizationInputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CaseSummarizationInputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CaseSummarizationInputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CaseSummarizationInputData) 

# ChunkingConfiguration
<a name="API_amazon-q-connect_ChunkingConfiguration"></a>

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

## Contents
<a name="API_amazon-q-connect_ChunkingConfiguration_Contents"></a>

 ** chunkingStrategy **   <a name="connect-Type-amazon-q-connect_ChunkingConfiguration-chunkingStrategy"></a>
Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE`, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.  
Type: String  
Valid Values: `FIXED_SIZE | NONE | HIERARCHICAL | SEMANTIC`   
Required: Yes

 ** fixedSizeChunkingConfiguration **   <a name="connect-Type-amazon-q-connect_ChunkingConfiguration-fixedSizeChunkingConfiguration"></a>
Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.  
Type: [FixedSizeChunkingConfiguration](API_amazon-q-connect_FixedSizeChunkingConfiguration.md) object  
Required: No

 ** hierarchicalChunkingConfiguration **   <a name="connect-Type-amazon-q-connect_ChunkingConfiguration-hierarchicalChunkingConfiguration"></a>
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.  
Type: [HierarchicalChunkingConfiguration](API_amazon-q-connect_HierarchicalChunkingConfiguration.md) object  
Required: No

 ** semanticChunkingConfiguration **   <a name="connect-Type-amazon-q-connect_ChunkingConfiguration-semanticChunkingConfiguration"></a>
Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.  
Type: [SemanticChunkingConfiguration](API_amazon-q-connect_SemanticChunkingConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ChunkingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ChunkingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ChunkingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ChunkingConfiguration) 

# Citation
<a name="API_amazon-q-connect_Citation"></a>

A citation that references source content.

## Contents
<a name="API_amazon-q-connect_Citation_Contents"></a>

 ** citationSpan **   <a name="connect-Type-amazon-q-connect_Citation-citationSpan"></a>
Contains information about where the text with a citation begins and ends in the generated output.  
Type: [CitationSpan](API_amazon-q-connect_CitationSpan.md) object  
Required: Yes

 ** referenceType **   <a name="connect-Type-amazon-q-connect_Citation-referenceType"></a>
A type to define the KB origin of a cited content  
Type: String  
Valid Values: `WEB_CRAWLER | KNOWLEDGE_BASE | BEDROCK_KB_S3 | BEDROCK_KB_WEB | BEDROCK_KB_CONFLUENCE | BEDROCK_KB_SALESFORCE | BEDROCK_KB_SHAREPOINT | BEDROCK_KB_KENDRA | BEDROCK_KB_CUSTOM_DOCUMENT | BEDROCK_KB_SQL`   
Required: Yes

 ** contentId **   <a name="connect-Type-amazon-q-connect_Citation-contentId"></a>
The identifier of the content being cited.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_Citation-knowledgeBaseId"></a>
The identifier of the knowledge base containing the cited content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** sourceURL **   <a name="connect-Type-amazon-q-connect_Citation-sourceURL"></a>
The source URL for the citation.  
Type: String  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_Citation-title"></a>
The title of the cited content.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_Citation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Citation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Citation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Citation) 

# CitationSpan
<a name="API_amazon-q-connect_CitationSpan"></a>

Contains information about where the text with a citation begins and ends in the generated output.

## Contents
<a name="API_amazon-q-connect_CitationSpan_Contents"></a>

 ** beginOffsetInclusive **   <a name="connect-Type-amazon-q-connect_CitationSpan-beginOffsetInclusive"></a>
Where the text with a citation starts in the generated output.  
Type: Integer  
Required: No

 ** endOffsetExclusive **   <a name="connect-Type-amazon-q-connect_CitationSpan-endOffsetExclusive"></a>
Where the text with a citation ends in the generated output.  
Type: Integer  
Required: No

## See Also
<a name="API_amazon-q-connect_CitationSpan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CitationSpan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CitationSpan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CitationSpan) 

# Configuration
<a name="API_amazon-q-connect_Configuration"></a>

The configuration information of the external data source.

## Contents
<a name="API_amazon-q-connect_Configuration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** connectConfiguration **   <a name="connect-Type-amazon-q-connect_Configuration-connectConfiguration"></a>
The configuration information of the Amazon Connect data source.  
Type: [ConnectConfiguration](API_amazon-q-connect_ConnectConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Configuration) 

# ConnectConfiguration
<a name="API_amazon-q-connect_ConnectConfiguration"></a>

The configuration information of the Amazon Connect data source.

## Contents
<a name="API_amazon-q-connect_ConnectConfiguration_Contents"></a>

 ** instanceId **   <a name="connect-Type-amazon-q-connect_ConnectConfiguration-instanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ConnectConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ConnectConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ConnectConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ConnectConfiguration) 

# ContentAssociationContents
<a name="API_amazon-q-connect_ContentAssociationContents"></a>

The contents of a content association.

## Contents
<a name="API_amazon-q-connect_ContentAssociationContents_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** amazonConnectGuideAssociation **   <a name="connect-Type-amazon-q-connect_ContentAssociationContents-amazonConnectGuideAssociation"></a>
The data of the step-by-step guide association.  
Type: [AmazonConnectGuideAssociationData](API_amazon-q-connect_AmazonConnectGuideAssociationData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentAssociationContents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentAssociationContents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentAssociationContents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentAssociationContents) 

# ContentAssociationData
<a name="API_amazon-q-connect_ContentAssociationData"></a>

Information about the content association.

## Contents
<a name="API_amazon-q-connect_ContentAssociationData_Contents"></a>

 ** associationData **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-associationData"></a>
The content association.  
Type: [ContentAssociationContents](API_amazon-q-connect_ContentAssociationContents.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** associationType **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-associationType"></a>
The type of association.  
Type: String  
Valid Values: `AMAZON_CONNECT_GUIDE`   
Required: Yes

 ** contentArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-contentArn"></a>
The Amazon Resource Name (ARN) of the content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentAssociationArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-contentAssociationArn"></a>
The Amazon Resource Name (ARN) of the content association.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentAssociationId **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-contentAssociationId"></a>
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentId **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-contentId"></a>
The identifier of the content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** tags **   <a name="connect-Type-amazon-q-connect_ContentAssociationData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentAssociationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentAssociationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentAssociationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentAssociationData) 

# ContentAssociationSummary
<a name="API_amazon-q-connect_ContentAssociationSummary"></a>

Summary information about a content association.

## Contents
<a name="API_amazon-q-connect_ContentAssociationSummary_Contents"></a>

 ** associationData **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-associationData"></a>
The content association.  
Type: [ContentAssociationContents](API_amazon-q-connect_ContentAssociationContents.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** associationType **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-associationType"></a>
The type of association.  
Type: String  
Valid Values: `AMAZON_CONNECT_GUIDE`   
Required: Yes

 ** contentArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-contentArn"></a>
The Amazon Resource Name (ARN) of the content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentAssociationArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-contentAssociationArn"></a>
The Amazon Resource Name (ARN) of the content association.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentAssociationId **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-contentAssociationId"></a>
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentId **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-contentId"></a>
The identifier of the content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** tags **   <a name="connect-Type-amazon-q-connect_ContentAssociationSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentAssociationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentAssociationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentAssociationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentAssociationSummary) 

# ContentData
<a name="API_amazon-q-connect_ContentData"></a>

Information about the content.

## Contents
<a name="API_amazon-q-connect_ContentData_Contents"></a>

 ** contentArn **   <a name="connect-Type-amazon-q-connect_ContentData-contentArn"></a>
The Amazon Resource Name (ARN) of the content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentId **   <a name="connect-Type-amazon-q-connect_ContentData-contentId"></a>
The identifier of the content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentType **   <a name="connect-Type-amazon-q-connect_ContentData-contentType"></a>
The media type of the content.  
Type: String  
Pattern: `(text/(plain|html|csv))|(application/(pdf|vnd\.openxmlformats-officedocument\.wordprocessingml\.document))|(application/x\.wisdom-json;source=(salesforce|servicenow|zendesk))`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ContentData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ContentData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** metadata **   <a name="connect-Type-amazon-q-connect_ContentData-metadata"></a>
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_ContentData-name"></a>
The name of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** revisionId **   <a name="connect-Type-amazon-q-connect_ContentData-revisionId"></a>
The identifier of the content revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_ContentData-status"></a>
The status of the content.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_FAILED`   
Required: Yes

 ** title **   <a name="connect-Type-amazon-q-connect_ContentData-title"></a>
The title of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** url **   <a name="connect-Type-amazon-q-connect_ContentData-url"></a>
The URL of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** urlExpiry **   <a name="connect-Type-amazon-q-connect_ContentData-urlExpiry"></a>
The expiration time of the URL as an epoch timestamp.  
Type: Timestamp  
Required: Yes

 ** linkOutUri **   <a name="connect-Type-amazon-q-connect_ContentData-linkOutUri"></a>
The URI of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_ContentData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentData) 

# ContentDataDetails
<a name="API_amazon-q-connect_ContentDataDetails"></a>

Details about the content data.

## Contents
<a name="API_amazon-q-connect_ContentDataDetails_Contents"></a>

 ** rankingData **   <a name="connect-Type-amazon-q-connect_ContentDataDetails-rankingData"></a>
Details about the content ranking data.  
Type: [RankingData](API_amazon-q-connect_RankingData.md) object  
Required: Yes

 ** textData **   <a name="connect-Type-amazon-q-connect_ContentDataDetails-textData"></a>
Details about the content text data.  
Type: [TextData](API_amazon-q-connect_TextData.md) object  
Required: Yes

## See Also
<a name="API_amazon-q-connect_ContentDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentDataDetails) 

# ContentFeedbackData
<a name="API_amazon-q-connect_ContentFeedbackData"></a>

Information about the feedback.

## Contents
<a name="API_amazon-q-connect_ContentFeedbackData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** generativeContentFeedbackData **   <a name="connect-Type-amazon-q-connect_ContentFeedbackData-generativeContentFeedbackData"></a>
Information about the feedback for a generative target type.  
Type: [GenerativeContentFeedbackData](API_amazon-q-connect_GenerativeContentFeedbackData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentFeedbackData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentFeedbackData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentFeedbackData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentFeedbackData) 

# ContentReference
<a name="API_amazon-q-connect_ContentReference"></a>

Reference information about the content.

## Contents
<a name="API_amazon-q-connect_ContentReference_Contents"></a>

 ** contentArn **   <a name="connect-Type-amazon-q-connect_ContentReference-contentArn"></a>
The Amazon Resource Name (ARN) of the content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

 ** contentId **   <a name="connect-Type-amazon-q-connect_ContentReference-contentId"></a>
The identifier of the content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ContentReference-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ContentReference-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** referenceType **   <a name="connect-Type-amazon-q-connect_ContentReference-referenceType"></a>
The type of reference content.  
Type: String  
Valid Values: `WEB_CRAWLER | KNOWLEDGE_BASE | BEDROCK_KB_S3 | BEDROCK_KB_WEB | BEDROCK_KB_CONFLUENCE | BEDROCK_KB_SALESFORCE | BEDROCK_KB_SHAREPOINT | BEDROCK_KB_KENDRA | BEDROCK_KB_CUSTOM_DOCUMENT | BEDROCK_KB_SQL`   
Required: No

 ** sourceURL **   <a name="connect-Type-amazon-q-connect_ContentReference-sourceURL"></a>
The web URL of the source content.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentReference) 

# ContentSummary
<a name="API_amazon-q-connect_ContentSummary"></a>

Summary information about the content.

## Contents
<a name="API_amazon-q-connect_ContentSummary_Contents"></a>

 ** contentArn **   <a name="connect-Type-amazon-q-connect_ContentSummary-contentArn"></a>
The Amazon Resource Name (ARN) of the content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** contentId **   <a name="connect-Type-amazon-q-connect_ContentSummary-contentId"></a>
The identifier of the content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentType **   <a name="connect-Type-amazon-q-connect_ContentSummary-contentType"></a>
The media type of the content.  
Type: String  
Pattern: `(text/(plain|html|csv))|(application/(pdf|vnd\.openxmlformats-officedocument\.wordprocessingml\.document))|(application/x\.wisdom-json;source=(salesforce|servicenow|zendesk))`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ContentSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ContentSummary-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** metadata **   <a name="connect-Type-amazon-q-connect_ContentSummary-metadata"></a>
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_ContentSummary-name"></a>
The name of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** revisionId **   <a name="connect-Type-amazon-q-connect_ContentSummary-revisionId"></a>
The identifier of the revision of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_ContentSummary-status"></a>
The status of the content.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_FAILED`   
Required: Yes

 ** title **   <a name="connect-Type-amazon-q-connect_ContentSummary-title"></a>
The title of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** tags **   <a name="connect-Type-amazon-q-connect_ContentSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_ContentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ContentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ContentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ContentSummary) 

# ConversationContext
<a name="API_amazon-q-connect_ConversationContext"></a>

The conversation context to include in SendMessage.

## Contents
<a name="API_amazon-q-connect_ConversationContext_Contents"></a>

 ** selfServiceConversationHistory **   <a name="connect-Type-amazon-q-connect_ConversationContext-selfServiceConversationHistory"></a>
The self service conversation history before the Amazon Q in Connect session.  
Type: Array of [SelfServiceConversationHistory](API_amazon-q-connect_SelfServiceConversationHistory.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_ConversationContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ConversationContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ConversationContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ConversationContext) 

# ConversationState
<a name="API_amazon-q-connect_ConversationState"></a>

The conversation state associated to a message.

## Contents
<a name="API_amazon-q-connect_ConversationState_Contents"></a>

 ** status **   <a name="connect-Type-amazon-q-connect_ConversationState-status"></a>
The status of the conversation state.  
Type: String  
Valid Values: `CLOSED | READY | PROCESSING`   
Required: Yes

 ** reason **   <a name="connect-Type-amazon-q-connect_ConversationState-reason"></a>
The reason of the conversation state.  
Type: String  
Valid Values: `SUCCESS | FAILED | REJECTED`   
Required: No

## See Also
<a name="API_amazon-q-connect_ConversationState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ConversationState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ConversationState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ConversationState) 

# CustomerProfileAttributes
<a name="API_amazon-q-connect_CustomerProfileAttributes"></a>

The customer profile attributes that are used with the message template.

## Contents
<a name="API_amazon-q-connect_CustomerProfileAttributes_Contents"></a>

 ** accountNumber **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-accountNumber"></a>
A unique account number that you have given to the customer.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** additionalInformation **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-additionalInformation"></a>
Any additional information relevant to the customer's profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** address1 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-address1"></a>
The first line of a customer address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** address2 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-address2"></a>
The second line of a customer address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** address3 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-address3"></a>
The third line of a customer address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** address4 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-address4"></a>
The fourth line of a customer address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingAddress1 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingAddress1"></a>
The first line of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingAddress2 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingAddress2"></a>
The second line of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingAddress3 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingAddress3"></a>
The third line of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingAddress4 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingAddress4"></a>
The fourth line of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingCity **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingCity"></a>
The city of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingCountry **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingCountry"></a>
The country of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingCounty **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingCounty"></a>
The county of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingPostalCode **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingPostalCode"></a>
The postal code of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingProvince **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingProvince"></a>
The province of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** billingState **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-billingState"></a>
The state of a customer’s billing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** birthDate **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-birthDate"></a>
The customer's birth date.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** businessEmailAddress **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-businessEmailAddress"></a>
The customer's business email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** businessName **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-businessName"></a>
The name of the customer's business.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** businessPhoneNumber **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-businessPhoneNumber"></a>
The customer's business phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** city **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-city"></a>
The city in which a customer lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** country **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-country"></a>
The country in which a customer lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** county **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-county"></a>
The county in which a customer lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** custom **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-custom"></a>
The custom attributes in customer profile attributes.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** emailAddress **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-emailAddress"></a>
The customer's email address, which has not been specified as a personal or business address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** firstName **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-firstName"></a>
The customer's first name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** gender **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-gender"></a>
The customer's gender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** homePhoneNumber **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-homePhoneNumber"></a>
The customer's mobile phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** lastName **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-lastName"></a>
The customer's last name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingAddress1 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingAddress1"></a>
The first line of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingAddress2 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingAddress2"></a>
The second line of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingAddress3 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingAddress3"></a>
The third line of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingAddress4 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingAddress4"></a>
The fourth line of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingCity **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingCity"></a>
The city of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingCountry **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingCountry"></a>
The country of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingCounty **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingCounty"></a>
The county of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingPostalCode **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingPostalCode"></a>
The postal code of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingProvince **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingProvince"></a>
The province of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mailingState **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mailingState"></a>
The state of a customer’s mailing address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** middleName **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-middleName"></a>
The customer's middle name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** mobilePhoneNumber **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-mobilePhoneNumber"></a>
The customer's mobile phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** partyType **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-partyType"></a>
The customer's party type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** phoneNumber **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-phoneNumber"></a>
The customer's phone number, which has not been specified as a mobile, home, or business number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** postalCode **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-postalCode"></a>
The postal code of a customer address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** profileARN **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-profileARN"></a>
The ARN of a customer profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** profileId **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-profileId"></a>
The unique identifier of a customer profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** province **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-province"></a>
The province in which a customer lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingAddress1 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingAddress1"></a>
The first line of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingAddress2 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingAddress2"></a>
The second line of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingAddress3 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingAddress3"></a>
The third line of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingAddress4 **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingAddress4"></a>
The fourth line of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingCity **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingCity"></a>
The city of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingCountry **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingCountry"></a>
The country of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingCounty **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingCounty"></a>
The county of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingPostalCode **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingPostalCode"></a>
The postal code of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingProvince **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingProvince"></a>
The province of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** shippingState **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-shippingState"></a>
The state of a customer’s shipping address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** state **   <a name="connect-Type-amazon-q-connect_CustomerProfileAttributes-state"></a>
The state in which a customer lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

## See Also
<a name="API_amazon-q-connect_CustomerProfileAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CustomerProfileAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CustomerProfileAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CustomerProfileAttributes) 

# DataDetails
<a name="API_amazon-q-connect_DataDetails"></a>

Details about the data.

## Contents
<a name="API_amazon-q-connect_DataDetails_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** caseSummarizationChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-caseSummarizationChunkData"></a>
Details about case summarization chunk data.  
Type: [CaseSummarizationChunkDataDetails](API_amazon-q-connect_CaseSummarizationChunkDataDetails.md) object  
Required: No

 ** contentData **   <a name="connect-Type-amazon-q-connect_DataDetails-contentData"></a>
Details about the content data.  
Type: [ContentDataDetails](API_amazon-q-connect_ContentDataDetails.md) object  
Required: No

 ** emailGenerativeAnswerChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-emailGenerativeAnswerChunkData"></a>
Streaming chunk data for email generative answers containing partial knowledge-based response content.  
Type: [EmailGenerativeAnswerChunkDataDetails](API_amazon-q-connect_EmailGenerativeAnswerChunkDataDetails.md) object  
Required: No

 ** emailOverviewChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-emailOverviewChunkData"></a>
Streaming chunk data for email overview containing partial overview content.  
Type: [EmailOverviewChunkDataDetails](API_amazon-q-connect_EmailOverviewChunkDataDetails.md) object  
Required: No

 ** emailResponseChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-emailResponseChunkData"></a>
Streaming chunk data for email response generation containing partial response content.  
Type: [EmailResponseChunkDataDetails](API_amazon-q-connect_EmailResponseChunkDataDetails.md) object  
Required: No

 ** generativeChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-generativeChunkData"></a>
Details about the generative chunk data.  
Type: [GenerativeChunkDataDetails](API_amazon-q-connect_GenerativeChunkDataDetails.md) object  
Required: No

 ** generativeData **   <a name="connect-Type-amazon-q-connect_DataDetails-generativeData"></a>
 Details about the generative data.  
Type: [GenerativeDataDetails](API_amazon-q-connect_GenerativeDataDetails.md) object  
Required: No

 ** intentDetectedData **   <a name="connect-Type-amazon-q-connect_DataDetails-intentDetectedData"></a>
Details about the intent data.  
Type: [IntentDetectedDataDetails](API_amazon-q-connect_IntentDetectedDataDetails.md) object  
Required: No

 ** notesChunkData **   <a name="connect-Type-amazon-q-connect_DataDetails-notesChunkData"></a>
Details about notes chunk data.  
Type: [NotesChunkDataDetails](API_amazon-q-connect_NotesChunkDataDetails.md) object  
Required: No

 ** notesData **   <a name="connect-Type-amazon-q-connect_DataDetails-notesData"></a>
Details about notes data.  
Type: [NotesDataDetails](API_amazon-q-connect_NotesDataDetails.md) object  
Required: No

 ** sourceContentData **   <a name="connect-Type-amazon-q-connect_DataDetails-sourceContentData"></a>
Details about the content data.  
Type: [SourceContentDataDetails](API_amazon-q-connect_SourceContentDataDetails.md) object  
Required: No

 ** suggestedMessageData **   <a name="connect-Type-amazon-q-connect_DataDetails-suggestedMessageData"></a>
Details about suggested message data.  
Type: [SuggestedMessageDataDetails](API_amazon-q-connect_SuggestedMessageDataDetails.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_DataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DataDetails) 

# DataReference
<a name="API_amazon-q-connect_DataReference"></a>

Reference data.

## Contents
<a name="API_amazon-q-connect_DataReference_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** contentReference **   <a name="connect-Type-amazon-q-connect_DataReference-contentReference"></a>
Reference information about the content.  
Type: [ContentReference](API_amazon-q-connect_ContentReference.md) object  
Required: No

 ** generativeReference **   <a name="connect-Type-amazon-q-connect_DataReference-generativeReference"></a>
Reference information about the generative content.  
Type: [GenerativeReference](API_amazon-q-connect_GenerativeReference.md) object  
Required: No

 ** suggestedMessageReference **   <a name="connect-Type-amazon-q-connect_DataReference-suggestedMessageReference"></a>
Reference information for suggested messages.  
Type: [SuggestedMessageReference](API_amazon-q-connect_SuggestedMessageReference.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_DataReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DataReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DataReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DataReference) 

# DataSummary
<a name="API_amazon-q-connect_DataSummary"></a>

Summary of the data.

## Contents
<a name="API_amazon-q-connect_DataSummary_Contents"></a>

 ** details **   <a name="connect-Type-amazon-q-connect_DataSummary-details"></a>
Details about the data.  
Type: [DataDetails](API_amazon-q-connect_DataDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** reference **   <a name="connect-Type-amazon-q-connect_DataSummary-reference"></a>
Reference information about the content.  
Type: [DataReference](API_amazon-q-connect_DataReference.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_DataSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DataSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DataSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DataSummary) 

# Document
<a name="API_amazon-q-connect_Document"></a>

The document.

## Contents
<a name="API_amazon-q-connect_Document_Contents"></a>

 ** contentReference **   <a name="connect-Type-amazon-q-connect_Document-contentReference"></a>
A reference to the content resource.  
Type: [ContentReference](API_amazon-q-connect_ContentReference.md) object  
Required: Yes

 ** excerpt **   <a name="connect-Type-amazon-q-connect_Document-excerpt"></a>
The excerpt from the document.  
Type: [DocumentText](API_amazon-q-connect_DocumentText.md) object  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_Document-title"></a>
The title of the document.  
Type: [DocumentText](API_amazon-q-connect_DocumentText.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_Document_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Document) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Document) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Document) 

# DocumentText
<a name="API_amazon-q-connect_DocumentText"></a>

The text of the document.

## Contents
<a name="API_amazon-q-connect_DocumentText_Contents"></a>

 ** highlights **   <a name="connect-Type-amazon-q-connect_DocumentText-highlights"></a>
Highlights in the document text.  
Type: Array of [Highlight](API_amazon-q-connect_Highlight.md) objects  
Required: No

 ** text **   <a name="connect-Type-amazon-q-connect_DocumentText-text"></a>
Text in the document.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_DocumentText_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DocumentText) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DocumentText) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DocumentText) 

# EmailGenerativeAnswerAIAgentConfiguration
<a name="API_amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration"></a>

Configuration settings for the EMAIL\$1GENERATIVE\$1ANSWER AI agent including prompts, locale, and knowledge base associations.

## Contents
<a name="API_amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration_Contents"></a>

 ** associationConfigurations **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration-associationConfigurations"></a>
Configuration settings for knowledge base associations used by the email generative answer agent.  
Type: Array of [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) objects  
Required: No

 ** emailGenerativeAnswerAIPromptId **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration-emailGenerativeAnswerAIPromptId"></a>
The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** emailQueryReformulationAIPromptId **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration-emailQueryReformulationAIPromptId"></a>
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration-locale"></a>
The locale setting for language-specific email processing and response generation (for example, en\$1US, es\$1ES).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailGenerativeAnswerAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailGenerativeAnswerAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailGenerativeAnswerAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailGenerativeAnswerAIAgentConfiguration) 

# EmailGenerativeAnswerChunkDataDetails
<a name="API_amazon-q-connect_EmailGenerativeAnswerChunkDataDetails"></a>

Details of streaming chunk data for email generative answers including completion text and references.

## Contents
<a name="API_amazon-q-connect_EmailGenerativeAnswerChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerChunkDataDetails-completion"></a>
The partial or complete text content of the generative answer response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerChunkDataDetails-nextChunkToken"></a>
Token for retrieving the next chunk of streaming response data, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** references **   <a name="connect-Type-amazon-q-connect_EmailGenerativeAnswerChunkDataDetails-references"></a>
Source references and citations from knowledge base articles used to generate the answer.  
Type: Array of [DataSummary](API_amazon-q-connect_DataSummary.md) objects  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailGenerativeAnswerChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailGenerativeAnswerChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailGenerativeAnswerChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailGenerativeAnswerChunkDataDetails) 

# EmailHeader
<a name="API_amazon-q-connect_EmailHeader"></a>

The email header to include in email messages.

## Contents
<a name="API_amazon-q-connect_EmailHeader_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_EmailHeader-name"></a>
The name of the email header.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 126.  
Pattern: `[!-9;-@A-~]+`   
Required: No

 ** value **   <a name="connect-Type-amazon-q-connect_EmailHeader-value"></a>
The value of the email header.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 870.  
Pattern: `.*[ -~]*.*`   
Required: No

## See Also
<a name="API_amazon-q-connect_EmailHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailHeader) 

# EmailMessageTemplateContent
<a name="API_amazon-q-connect_EmailMessageTemplateContent"></a>

The content of the message template that applies to the email channel subtype.

## Contents
<a name="API_amazon-q-connect_EmailMessageTemplateContent_Contents"></a>

 ** body **   <a name="connect-Type-amazon-q-connect_EmailMessageTemplateContent-body"></a>
The body to use in email messages.  
Type: [EmailMessageTemplateContentBody](API_amazon-q-connect_EmailMessageTemplateContentBody.md) object  
Required: No

 ** headers **   <a name="connect-Type-amazon-q-connect_EmailMessageTemplateContent-headers"></a>
The email headers to include in email messages.  
Type: Array of [EmailHeader](API_amazon-q-connect_EmailHeader.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 15 items.  
Required: No

 ** subject **   <a name="connect-Type-amazon-q-connect_EmailMessageTemplateContent-subject"></a>
The subject line, or title, to use in email messages.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailMessageTemplateContent) 

# EmailMessageTemplateContentBody
<a name="API_amazon-q-connect_EmailMessageTemplateContentBody"></a>

The body to use in email messages.

## Contents
<a name="API_amazon-q-connect_EmailMessageTemplateContentBody_Contents"></a>

 ** html **   <a name="connect-Type-amazon-q-connect_EmailMessageTemplateContentBody-html"></a>
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** plainText **   <a name="connect-Type-amazon-q-connect_EmailMessageTemplateContentBody-plainText"></a>
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailMessageTemplateContentBody_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailMessageTemplateContentBody) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailMessageTemplateContentBody) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailMessageTemplateContentBody) 

# EmailOverviewAIAgentConfiguration
<a name="API_amazon-q-connect_EmailOverviewAIAgentConfiguration"></a>

Configuration settings for the EMAIL\$1OVERVIEW AI agent including prompt ID and locale settings.

## Contents
<a name="API_amazon-q-connect_EmailOverviewAIAgentConfiguration_Contents"></a>

 ** emailOverviewAIPromptId **   <a name="connect-Type-amazon-q-connect_EmailOverviewAIAgentConfiguration-emailOverviewAIPromptId"></a>
The ID of the System AI prompt used for generating structured email conversation summaries.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_EmailOverviewAIAgentConfiguration-locale"></a>
The locale setting for language-specific email overview processing (for example, en\$1US, es\$1ES).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailOverviewAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailOverviewAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailOverviewAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailOverviewAIAgentConfiguration) 

# EmailOverviewChunkDataDetails
<a name="API_amazon-q-connect_EmailOverviewChunkDataDetails"></a>

Details of streaming chunk data for email overview including completion text and pagination tokens.

## Contents
<a name="API_amazon-q-connect_EmailOverviewChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_EmailOverviewChunkDataDetails-completion"></a>
The partial or complete overview text content in structured HTML format with customer issues, resolutions, and next steps.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_EmailOverviewChunkDataDetails-nextChunkToken"></a>
Token for retrieving the next chunk of streaming overview data, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailOverviewChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailOverviewChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailOverviewChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailOverviewChunkDataDetails) 

# EmailResponseAIAgentConfiguration
<a name="API_amazon-q-connect_EmailResponseAIAgentConfiguration"></a>

Configuration settings for the EMAIL\$1RESPONSE AI agent including prompts, locale, and knowledge base associations.

## Contents
<a name="API_amazon-q-connect_EmailResponseAIAgentConfiguration_Contents"></a>

 ** associationConfigurations **   <a name="connect-Type-amazon-q-connect_EmailResponseAIAgentConfiguration-associationConfigurations"></a>
Configuration settings for knowledge base associations used by the email response agent.  
Type: Array of [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) objects  
Required: No

 ** emailQueryReformulationAIPromptId **   <a name="connect-Type-amazon-q-connect_EmailResponseAIAgentConfiguration-emailQueryReformulationAIPromptId"></a>
The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** emailResponseAIPromptId **   <a name="connect-Type-amazon-q-connect_EmailResponseAIAgentConfiguration-emailResponseAIPromptId"></a>
The ID of the System AI prompt used for generating professional email responses based on knowledge base content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_EmailResponseAIAgentConfiguration-locale"></a>
The locale setting for language-specific email response generation (for example, en\$1US, es\$1ES).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailResponseAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailResponseAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailResponseAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailResponseAIAgentConfiguration) 

# EmailResponseChunkDataDetails
<a name="API_amazon-q-connect_EmailResponseChunkDataDetails"></a>

Details of streaming chunk data for email responses including completion text and pagination tokens.

## Contents
<a name="API_amazon-q-connect_EmailResponseChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_EmailResponseChunkDataDetails-completion"></a>
The partial or complete professional email response text with appropriate greetings and closings.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_EmailResponseChunkDataDetails-nextChunkToken"></a>
Token for retrieving the next chunk of streaming response data, if available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_EmailResponseChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/EmailResponseChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/EmailResponseChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/EmailResponseChunkDataDetails) 

# ExtendedMessageTemplateData
<a name="API_amazon-q-connect_ExtendedMessageTemplateData"></a>

The extended data of a message template.

## Contents
<a name="API_amazon-q-connect_ExtendedMessageTemplateData_Contents"></a>

 ** channelSubtype **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-createdTime"></a>
The timestamp when the message template was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the message template data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-lastModifiedTime"></a>
The timestamp when the message template data was last modified.  
Type: Timestamp  
Required: Yes

 ** messageTemplateArn **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** messageTemplateContentSha256 **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-messageTemplateContentSha256"></a>
The checksum value of the message template content that is referenced by the `$LATEST` qualifier. It can be returned in `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s calculated by content, language, `defaultAttributes` and `Attachments` of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+`   
Required: Yes

 ** messageTemplateId **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** attachments **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-attachments"></a>
The message template attachments.  
Type: Array of [MessageTemplateAttachment](API_amazon-q-connect_MessageTemplateAttachment.md) objects  
Required: No

 ** attributeTypes **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-attributeTypes"></a>
The types of attributes contain the message template.  
Type: Array of strings  
Valid Values: `SYSTEM | AGENT | CUSTOMER_PROFILE | CUSTOM`   
Required: No

 ** channel **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-channel"></a>
The channel of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** content **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-content"></a>
The content of the message template.  
Type: [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** defaultAttributes **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-defaultAttributes"></a>
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.  
Type: [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** groupingConfiguration **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-groupingConfiguration"></a>
The configuration information of the grouping of Amazon Q in Connect users.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** isActive **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-isActive"></a>
Whether the version of the message template is activated.  
Type: Boolean  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** sourceConfigurationSummary **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-sourceConfigurationSummary"></a>
The source configuration summary of the message template.  
Type: [MessageTemplateSourceConfigurationSummary](API_amazon-q-connect_MessageTemplateSourceConfigurationSummary.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_ExtendedMessageTemplateData-versionNumber"></a>
The version number of the message template version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_ExtendedMessageTemplateData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ExtendedMessageTemplateData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ExtendedMessageTemplateData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ExtendedMessageTemplateData) 

# ExternalBedrockKnowledgeBaseConfig
<a name="API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig"></a>

Configuration for an external Bedrock knowledge base.

## Contents
<a name="API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig_Contents"></a>

 ** accessRoleArn **   <a name="connect-Type-amazon-q-connect_ExternalBedrockKnowledgeBaseConfig-accessRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.  
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 2048.  
Pattern: `arn:aws:iam::[0-9]{12}:role/(?:service-role/)?[a-zA-Z0-9_+=,.@-]{1,64}`   
Required: Yes

 ** bedrockKnowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ExternalBedrockKnowledgeBaseConfig-bedrockKnowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the external Bedrock knowledge base.  
Type: String  
Length Constraints: Minimum length of 47. Maximum length of 128.  
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_ExternalBedrockKnowledgeBaseConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ExternalBedrockKnowledgeBaseConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ExternalBedrockKnowledgeBaseConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ExternalBedrockKnowledgeBaseConfig) 

# ExternalSourceConfiguration
<a name="API_amazon-q-connect_ExternalSourceConfiguration"></a>

The configuration information of the external data source.

## Contents
<a name="API_amazon-q-connect_ExternalSourceConfiguration_Contents"></a>

 ** configuration **   <a name="connect-Type-amazon-q-connect_ExternalSourceConfiguration-configuration"></a>
The configuration information of the external data source.  
Type: [Configuration](API_amazon-q-connect_Configuration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** source **   <a name="connect-Type-amazon-q-connect_ExternalSourceConfiguration-source"></a>
The type of the external data source.  
Type: String  
Valid Values: `AMAZON_CONNECT`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_ExternalSourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ExternalSourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ExternalSourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ExternalSourceConfiguration) 

# Filter
<a name="API_amazon-q-connect_Filter"></a>

A search filter.

## Contents
<a name="API_amazon-q-connect_Filter_Contents"></a>

 ** field **   <a name="connect-Type-amazon-q-connect_Filter-field"></a>
The field on which to filter.  
Type: String  
Valid Values: `NAME`   
Required: Yes

 ** operator **   <a name="connect-Type-amazon-q-connect_Filter-operator"></a>
The operator to use for comparing the field’s value with the provided value.  
Type: String  
Valid Values: `EQUALS`   
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_Filter-value"></a>
The desired field value on which to filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Filter) 

# FilterAttribute
<a name="API_amazon-q-connect_FilterAttribute"></a>

An attribute used for filtering.

## Contents
<a name="API_amazon-q-connect_FilterAttribute_Contents"></a>

 ** key **   <a name="connect-Type-amazon-q-connect_FilterAttribute-key"></a>
The key of the filter attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_FilterAttribute-value"></a>
The value of the filter attribute.  
Type: JSON value  
Required: Yes

## See Also
<a name="API_amazon-q-connect_FilterAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/FilterAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/FilterAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/FilterAttribute) 

# FixedSizeChunkingConfiguration
<a name="API_amazon-q-connect_FixedSizeChunkingConfiguration"></a>

Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.

## Contents
<a name="API_amazon-q-connect_FixedSizeChunkingConfiguration_Contents"></a>

 ** maxTokens **   <a name="connect-Type-amazon-q-connect_FixedSizeChunkingConfiguration-maxTokens"></a>
The maximum number of tokens to include in a chunk.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

 ** overlapPercentage **   <a name="connect-Type-amazon-q-connect_FixedSizeChunkingConfiguration-overlapPercentage"></a>
The percentage of overlap between adjacent chunks of a data source.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 99.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_FixedSizeChunkingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/FixedSizeChunkingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/FixedSizeChunkingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/FixedSizeChunkingConfiguration) 

# GenerativeChunkDataDetails
<a name="API_amazon-q-connect_GenerativeChunkDataDetails"></a>

Details about the generative chunk data.

## Contents
<a name="API_amazon-q-connect_GenerativeChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_GenerativeChunkDataDetails-completion"></a>
A chunk of the LLM response.  
Type: String  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_GenerativeChunkDataDetails-nextChunkToken"></a>
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** references **   <a name="connect-Type-amazon-q-connect_GenerativeChunkDataDetails-references"></a>
The references used to generate the LLM response.  
Type: Array of [DataSummary](API_amazon-q-connect_DataSummary.md) objects  
Required: No

## See Also
<a name="API_amazon-q-connect_GenerativeChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GenerativeChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GenerativeChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GenerativeChunkDataDetails) 

# GenerativeContentFeedbackData
<a name="API_amazon-q-connect_GenerativeContentFeedbackData"></a>

The feedback information for a generative target type.

## Contents
<a name="API_amazon-q-connect_GenerativeContentFeedbackData_Contents"></a>

 ** relevance **   <a name="connect-Type-amazon-q-connect_GenerativeContentFeedbackData-relevance"></a>
The relevance of the feedback.  
Type: String  
Valid Values: `HELPFUL | NOT_HELPFUL`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_GenerativeContentFeedbackData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GenerativeContentFeedbackData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GenerativeContentFeedbackData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GenerativeContentFeedbackData) 

# GenerativeDataDetails
<a name="API_amazon-q-connect_GenerativeDataDetails"></a>

Details about generative data.

## Contents
<a name="API_amazon-q-connect_GenerativeDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_GenerativeDataDetails-completion"></a>
The LLM response.  
Type: String  
Required: Yes

 ** rankingData **   <a name="connect-Type-amazon-q-connect_GenerativeDataDetails-rankingData"></a>
Details about the generative content ranking data.  
Type: [RankingData](API_amazon-q-connect_RankingData.md) object  
Required: Yes

 ** references **   <a name="connect-Type-amazon-q-connect_GenerativeDataDetails-references"></a>
The references used to generative the LLM response.  
Type: Array of [DataSummary](API_amazon-q-connect_DataSummary.md) objects  
Required: Yes

## See Also
<a name="API_amazon-q-connect_GenerativeDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GenerativeDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GenerativeDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GenerativeDataDetails) 

# GenerativeReference
<a name="API_amazon-q-connect_GenerativeReference"></a>

Reference information about generative content.

## Contents
<a name="API_amazon-q-connect_GenerativeReference_Contents"></a>

 ** generationId **   <a name="connect-Type-amazon-q-connect_GenerativeReference-generationId"></a>
 The identifier of the LLM model.   
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** modelId **   <a name="connect-Type-amazon-q-connect_GenerativeReference-modelId"></a>
The identifier of the LLM model.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## See Also
<a name="API_amazon-q-connect_GenerativeReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GenerativeReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GenerativeReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GenerativeReference) 

# GroupingConfiguration
<a name="API_amazon-q-connect_GroupingConfiguration"></a>

The configuration information of the grouping of Amazon Q in Connect users.

## Contents
<a name="API_amazon-q-connect_GroupingConfiguration_Contents"></a>

 ** criteria **   <a name="connect-Type-amazon-q-connect_GroupingConfiguration-criteria"></a>
The criteria used for grouping Amazon Q in Connect users.  
The following is the list of supported criteria values.  
+  `RoutingProfileArn`: Grouping the users by their [Amazon Connect routing profile ARN](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html). User should have [SearchRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) and [DescribeRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) permissions when setting criteria to this value.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** values **   <a name="connect-Type-amazon-q-connect_GroupingConfiguration-values"></a>
The list of values that define different groups of Amazon Q in Connect users.  
+ When setting `criteria` to `RoutingProfileArn`, you need to provide a list of ARNs of [Amazon Connect routing profiles](https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html) as values of this parameter.
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_GroupingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GroupingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GroupingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GroupingConfiguration) 

# GuardrailContentFilterConfig
<a name="API_amazon-q-connect_GuardrailContentFilterConfig"></a>

Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
+  **Hate**: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
+  **Insults**: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
+  **Sexual**: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
+  **Violence**: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.

Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, * Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence.

## Contents
<a name="API_amazon-q-connect_GuardrailContentFilterConfig_Contents"></a>

 ** inputStrength **   <a name="connect-Type-amazon-q-connect_GuardrailContentFilterConfig-inputStrength"></a>
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.  
Type: String  
Valid Values: `NONE | LOW | MEDIUM | HIGH`   
Required: Yes

 ** outputStrength **   <a name="connect-Type-amazon-q-connect_GuardrailContentFilterConfig-outputStrength"></a>
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.  
Type: String  
Valid Values: `NONE | LOW | MEDIUM | HIGH`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_GuardrailContentFilterConfig-type"></a>
The harmful category that the content filter is applied to.  
Type: String  
Valid Values: `SEXUAL | VIOLENCE | HATE | INSULTS | MISCONDUCT | PROMPT_ATTACK`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_GuardrailContentFilterConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailContentFilterConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailContentFilterConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailContentFilterConfig) 

# GuardrailContextualGroundingFilterConfig
<a name="API_amazon-q-connect_GuardrailContextualGroundingFilterConfig"></a>

The filter configuration details for the AI Guardrail's contextual grounding filter.

## Contents
<a name="API_amazon-q-connect_GuardrailContextualGroundingFilterConfig_Contents"></a>

 ** threshold **   <a name="connect-Type-amazon-q-connect_GuardrailContextualGroundingFilterConfig-threshold"></a>
The threshold details for the AI Guardrail's contextual grounding filter.  
Type: Double  
Valid Range: Minimum value of 0.  
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_GuardrailContextualGroundingFilterConfig-type"></a>
The filter type for the AI Guardrail's contextual grounding filter.  
Type: String  
Valid Values: `GROUNDING | RELEVANCE`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_GuardrailContextualGroundingFilterConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailContextualGroundingFilterConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailContextualGroundingFilterConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailContextualGroundingFilterConfig) 

# GuardrailManagedWordsConfig
<a name="API_amazon-q-connect_GuardrailManagedWordsConfig"></a>

The managed word list to configure for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_GuardrailManagedWordsConfig_Contents"></a>

 ** type **   <a name="connect-Type-amazon-q-connect_GuardrailManagedWordsConfig-type"></a>
The managed word type to configure for the AI Guardrail.  
Type: String  
Valid Values: `PROFANITY`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_GuardrailManagedWordsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailManagedWordsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailManagedWordsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailManagedWordsConfig) 

# GuardrailPiiEntityConfig
<a name="API_amazon-q-connect_GuardrailPiiEntityConfig"></a>

The PII entity to configure for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_GuardrailPiiEntityConfig_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_GuardrailPiiEntityConfig-action"></a>
Configure AI Guardrail's action when the PII entity is detected.  
Type: String  
Valid Values: `BLOCK | ANONYMIZE`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_GuardrailPiiEntityConfig-type"></a>
Configure AI Guardrail type when the PII entity is detected.  
The following PIIs are used to block or mask sensitive information:  
+  **General** 
  +  **ADDRESS** 

    A physical address, such as "100 Main Street, Anytown, USA" or "Suite \$112, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. 
  +  **AGE** 

    An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. 
  +  **NAME** 

    An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. 
  +  **EMAIL** 

    An email address, such as *marymajor@email.com*.
  +  **PHONE** 

    A phone number. This entity type also includes fax and pager numbers. 
  +  **USERNAME** 

    A user name that identifies an account, such as a login name, screen name, nick name, or handle. 
  +  **PASSWORD** 

    An alphanumeric string that is used as a password, such as "\$1* very20special\$1pass\$1*". 
  +  **DRIVER\$1ID** 

    The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. 
  +  **LICENSE\$1PLATE** 

    A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. 
  +  **VEHICLE\$1IDENTIFICATION\$1NUMBER** 

    A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. 
+  **Finance** 
  +  **CREDIT\$1DEBIT\$1CARD\$1CVV** 

    A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. 
  +  **CREDIT\$1DEBIT\$1CARD\$1EXPIRY** 

    The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. AI Guardrail recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. 
  +  **CREDIT\$1DEBIT\$1CARD\$1NUMBER** 

    The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. 
  +  **PIN** 

    A four-digit personal identification number (PIN) with which you can access your bank account. 
  +  **INTERNATIONAL\$1BANK\$1ACCOUNT\$1NUMBER** 

    An International Bank Account Number has specific formats in each country. For more information, see [ www.iban.com/structure](https://www.iban.com/structure).
  +  **SWIFT\$1CODE** 

    A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

    SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
+  **IT** 
  +  **IP\$1ADDRESS** 

    An IPv4 address, such as *198.51.100.0*. 
  +  **MAC\$1ADDRESS** 

    A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). 
  +  **URL** 

    A web address, such as *www.example.com*. 
  +  **AWS\$1ACCESS\$1KEY** 

    A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically. 
  +  **AWS\$1SECRET\$1KEY** 

    A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically. 
+  **USA specific** 
  +  **US\$1BANK\$1ACCOUNT\$1NUMBER** 

    A US bank account number, which is typically 10 to 12 digits long. 
  +  **US\$1BANK\$1ROUTING\$1NUMBER** 

    A US bank account routing number. These are typically nine digits long, 
  +  **US\$1INDIVIDUAL\$1TAX\$1IDENTIFICATION\$1NUMBER** 

    A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. 
  +  **US\$1PASSPORT\$1NUMBER** 

    A US passport number. Passport numbers range from six to nine alphanumeric characters. 
  +  **US\$1SOCIAL\$1SECURITY\$1NUMBER** 

    A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. 
+  **Canada specific** 
  +  **CA\$1HEALTH\$1NUMBER** 

    A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. 
  +  **CA\$1SOCIAL\$1INSURANCE\$1NUMBER** 

    A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

    The SIN is formatted as three groups of three digits, such as * 123-456-789*. A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://www.wikipedia.org/wiki/Luhn_algorithm) .
+  **UK Specific** 
  +  **UK\$1NATIONAL\$1HEALTH\$1SERVICE\$1NUMBER** 

    A UK National Health Service Number is a 10-17 digit number, such as *485 555 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
  +  **UK\$1NATIONAL\$1INSURANCE\$1NUMBER** 

    A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

    The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
  +  **UK\$1UNIQUE\$1TAXPAYER\$1REFERENCE\$1NUMBER** 

    A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. 
+  **Custom** 
  +  **Regex filter** - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..
Type: String  
Valid Values: `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

## See Also
<a name="API_amazon-q-connect_GuardrailPiiEntityConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailPiiEntityConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailPiiEntityConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailPiiEntityConfig) 

# GuardrailRegexConfig
<a name="API_amazon-q-connect_GuardrailRegexConfig"></a>

The regular expression to configure for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_GuardrailRegexConfig_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_GuardrailRegexConfig-action"></a>
The AI Guardrail action to configure when matching regular expression is detected.  
Type: String  
Valid Values: `BLOCK | ANONYMIZE`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_GuardrailRegexConfig-name"></a>
The name of the regular expression to configure for the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** pattern **   <a name="connect-Type-amazon-q-connect_GuardrailRegexConfig-pattern"></a>
The regular expression pattern to configure for the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_GuardrailRegexConfig-description"></a>
The description of the regular expression to configure for the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

## See Also
<a name="API_amazon-q-connect_GuardrailRegexConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailRegexConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailRegexConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailRegexConfig) 

# GuardrailTopicConfig
<a name="API_amazon-q-connect_GuardrailTopicConfig"></a>

Details about topics for the AI Guardrail to identify and deny.

## Contents
<a name="API_amazon-q-connect_GuardrailTopicConfig_Contents"></a>

 ** definition **   <a name="connect-Type-amazon-q-connect_GuardrailTopicConfig-definition"></a>
A definition of the topic to deny.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_GuardrailTopicConfig-name"></a>
The name of the topic to deny.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9a-zA-Z-_ !?.]+`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_GuardrailTopicConfig-type"></a>
Specifies to deny the topic.  
Type: String  
Valid Values: `DENY`   
Required: Yes

 ** examples **   <a name="connect-Type-amazon-q-connect_GuardrailTopicConfig-examples"></a>
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## See Also
<a name="API_amazon-q-connect_GuardrailTopicConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailTopicConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailTopicConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailTopicConfig) 

# GuardrailWordConfig
<a name="API_amazon-q-connect_GuardrailWordConfig"></a>

A word to configure for the AI Guardrail.

## Contents
<a name="API_amazon-q-connect_GuardrailWordConfig_Contents"></a>

 ** text **   <a name="connect-Type-amazon-q-connect_GuardrailWordConfig-text"></a>
Text of the word configured for the AI Guardrail to block.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_GuardrailWordConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GuardrailWordConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GuardrailWordConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GuardrailWordConfig) 

# HierarchicalChunkingConfiguration
<a name="API_amazon-q-connect_HierarchicalChunkingConfiguration"></a>

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

## Contents
<a name="API_amazon-q-connect_HierarchicalChunkingConfiguration_Contents"></a>

 ** levelConfigurations **   <a name="connect-Type-amazon-q-connect_HierarchicalChunkingConfiguration-levelConfigurations"></a>
Token settings for each layer.  
Type: Array of [HierarchicalChunkingLevelConfiguration](API_amazon-q-connect_HierarchicalChunkingLevelConfiguration.md) objects  
Array Members: Fixed number of 2 items.  
Required: Yes

 ** overlapTokens **   <a name="connect-Type-amazon-q-connect_HierarchicalChunkingConfiguration-overlapTokens"></a>
The number of tokens to repeat across chunks in the same layer.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_HierarchicalChunkingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/HierarchicalChunkingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/HierarchicalChunkingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/HierarchicalChunkingConfiguration) 

# HierarchicalChunkingLevelConfiguration
<a name="API_amazon-q-connect_HierarchicalChunkingLevelConfiguration"></a>

Token settings for each layer.

## Contents
<a name="API_amazon-q-connect_HierarchicalChunkingLevelConfiguration_Contents"></a>

 ** maxTokens **   <a name="connect-Type-amazon-q-connect_HierarchicalChunkingLevelConfiguration-maxTokens"></a>
The maximum number of tokens that a chunk can contain in this layer.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 8192.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_HierarchicalChunkingLevelConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/HierarchicalChunkingLevelConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/HierarchicalChunkingLevelConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/HierarchicalChunkingLevelConfiguration) 

# Highlight
<a name="API_amazon-q-connect_Highlight"></a>

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

## Contents
<a name="API_amazon-q-connect_Highlight_Contents"></a>

 ** beginOffsetInclusive **   <a name="connect-Type-amazon-q-connect_Highlight-beginOffsetInclusive"></a>
The offset for the start of the highlight.  
Type: Integer  
Required: No

 ** endOffsetExclusive **   <a name="connect-Type-amazon-q-connect_Highlight-endOffsetExclusive"></a>
The offset for the end of the highlight.  
Type: Integer  
Required: No

## See Also
<a name="API_amazon-q-connect_Highlight_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Highlight) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Highlight) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Highlight) 

# ImportJobData
<a name="API_amazon-q-connect_ImportJobData"></a>

Summary information about the import job.

## Contents
<a name="API_amazon-q-connect_ImportJobData_Contents"></a>

 ** createdTime **   <a name="connect-Type-amazon-q-connect_ImportJobData-createdTime"></a>
The timestamp when the import job was created.  
Type: Timestamp  
Required: Yes

 ** importJobId **   <a name="connect-Type-amazon-q-connect_ImportJobData-importJobId"></a>
The identifier of the import job.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** importJobType **   <a name="connect-Type-amazon-q-connect_ImportJobData-importJobType"></a>
The type of the import job.  
Type: String  
Valid Values: `QUICK_RESPONSES`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ImportJobData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ImportJobData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_ImportJobData-lastModifiedTime"></a>
The timestamp when the import job data was last modified.  
Type: Timestamp  
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_ImportJobData-status"></a>
The status of the import job.  
Type: String  
Valid Values: `START_IN_PROGRESS | FAILED | COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** uploadId **   <a name="connect-Type-amazon-q-connect_ImportJobData-uploadId"></a>
A pointer to the uploaded asset. This value is returned by [StartContentUpload](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.  
Required: Yes

 ** url **   <a name="connect-Type-amazon-q-connect_ImportJobData-url"></a>
The download link to the resource file that is uploaded to the import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** urlExpiry **   <a name="connect-Type-amazon-q-connect_ImportJobData-urlExpiry"></a>
The expiration time of the URL as an epoch timestamp.  
Type: Timestamp  
Required: Yes

 ** externalSourceConfiguration **   <a name="connect-Type-amazon-q-connect_ImportJobData-externalSourceConfiguration"></a>
The configuration information of the external data source.  
Type: [ExternalSourceConfiguration](API_amazon-q-connect_ExternalSourceConfiguration.md) object  
Required: No

 ** failedRecordReport **   <a name="connect-Type-amazon-q-connect_ImportJobData-failedRecordReport"></a>
The link to download the information of resource data that failed to be imported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** metadata **   <a name="connect-Type-amazon-q-connect_ImportJobData-metadata"></a>
The metadata fields of the imported Amazon Q in Connect resources.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ImportJobData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ImportJobData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ImportJobData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ImportJobData) 

# ImportJobSummary
<a name="API_amazon-q-connect_ImportJobSummary"></a>

Summary information about the import job.

## Contents
<a name="API_amazon-q-connect_ImportJobSummary_Contents"></a>

 ** createdTime **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-createdTime"></a>
The timestamp when the import job was created.  
Type: Timestamp  
Required: Yes

 ** importJobId **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-importJobId"></a>
The identifier of the import job.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** importJobType **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-importJobType"></a>
The type of import job.  
Type: String  
Valid Values: `QUICK_RESPONSES`   
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-lastModifiedTime"></a>
The timestamp when the import job was last modified.  
Type: Timestamp  
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-status"></a>
The status of the import job.  
Type: String  
Valid Values: `START_IN_PROGRESS | FAILED | COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** uploadId **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-uploadId"></a>
A pointer to the uploaded asset. This value is returned by [StartContentUpload](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.  
Required: Yes

 ** externalSourceConfiguration **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-externalSourceConfiguration"></a>
The configuration information of the external source that the resource data are imported from.  
Type: [ExternalSourceConfiguration](API_amazon-q-connect_ExternalSourceConfiguration.md) object  
Required: No

 ** metadata **   <a name="connect-Type-amazon-q-connect_ImportJobSummary-metadata"></a>
The metadata fields of the imported Amazon Q in Connect resources.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ImportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ImportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ImportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ImportJobSummary) 

# IntentDetectedDataDetails
<a name="API_amazon-q-connect_IntentDetectedDataDetails"></a>

Details about the detected intent.

## Contents
<a name="API_amazon-q-connect_IntentDetectedDataDetails_Contents"></a>

 ** intent **   <a name="connect-Type-amazon-q-connect_IntentDetectedDataDetails-intent"></a>
The detected intent.  
Type: String  
Required: Yes

 ** intentId **   <a name="connect-Type-amazon-q-connect_IntentDetectedDataDetails-intentId"></a>
The identifier of the detected intent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** relevanceLevel **   <a name="connect-Type-amazon-q-connect_IntentDetectedDataDetails-relevanceLevel"></a>
The relevance level of the detected intent.  
Type: String  
Valid Values: `HIGH | MEDIUM | LOW`   
Required: No

## See Also
<a name="API_amazon-q-connect_IntentDetectedDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/IntentDetectedDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/IntentDetectedDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/IntentDetectedDataDetails) 

# IntentInputData
<a name="API_amazon-q-connect_IntentInputData"></a>

Information about the Amazon Q intent.

## Contents
<a name="API_amazon-q-connect_IntentInputData_Contents"></a>

 ** intentId **   <a name="connect-Type-amazon-q-connect_IntentInputData-intentId"></a>
The identifier of the Amazon Q intent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_IntentInputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/IntentInputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/IntentInputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/IntentInputData) 

# KnowledgeBaseAssociationConfigurationData
<a name="API_amazon-q-connect_KnowledgeBaseAssociationConfigurationData"></a>

The data of the configuration for a `KNOWLEDGE_BASE` type Amazon Q in Connect Assistant Association.

## Contents
<a name="API_amazon-q-connect_KnowledgeBaseAssociationConfigurationData_Contents"></a>

 ** contentTagFilter **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseAssociationConfigurationData-contentTagFilter"></a>
An object that can be used to specify Tag conditions.  
Type: [TagFilter](API_amazon-q-connect_TagFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** maxResults **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseAssociationConfigurationData-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** overrideKnowledgeBaseSearchType **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseAssociationConfigurationData-overrideKnowledgeBaseSearchType"></a>
The search type to be used against the Knowledge Base for this request. The values can be `SEMANTIC` which uses vector embeddings or `HYBRID` which use vector embeddings and raw text  
Type: String  
Valid Values: `HYBRID | SEMANTIC`   
Required: No

## See Also
<a name="API_amazon-q-connect_KnowledgeBaseAssociationConfigurationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/KnowledgeBaseAssociationConfigurationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/KnowledgeBaseAssociationConfigurationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/KnowledgeBaseAssociationConfigurationData) 

# KnowledgeBaseAssociationData
<a name="API_amazon-q-connect_KnowledgeBaseAssociationData"></a>

Association information about the knowledge base.

## Contents
<a name="API_amazon-q-connect_KnowledgeBaseAssociationData_Contents"></a>

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseAssociationData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseAssociationData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_amazon-q-connect_KnowledgeBaseAssociationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/KnowledgeBaseAssociationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/KnowledgeBaseAssociationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/KnowledgeBaseAssociationData) 

# KnowledgeBaseData
<a name="API_amazon-q-connect_KnowledgeBaseData"></a>

Information about the knowledge base.

## Contents
<a name="API_amazon-q-connect_KnowledgeBaseData_Contents"></a>

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** knowledgeBaseType **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-knowledgeBaseType"></a>
The type of knowledge base.  
Type: String  
Valid Values: `EXTERNAL | CUSTOM | QUICK_RESPONSES | MESSAGE_TEMPLATES | MANAGED`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-name"></a>
The name of the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-status"></a>
The status of the knowledge base.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-description"></a>
The description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** ingestionFailureReasons **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-ingestionFailureReasons"></a>
List of failure reasons on ingestion per file.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** ingestionStatus **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-ingestionStatus"></a>
Status of ingestion on data source.  
Type: String  
Valid Values: `SYNC_FAILED | SYNCING_IN_PROGRESS | SYNC_SUCCESS | CREATE_IN_PROGRESS`   
Required: No

 ** lastContentModificationTime **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-lastContentModificationTime"></a>
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.  
Type: Timestamp  
Required: No

 ** renderingConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-renderingConfiguration"></a>
Information about how to render the content.  
Type: [RenderingConfiguration](API_amazon-q-connect_RenderingConfiguration.md) object  
Required: No

 ** serverSideEncryptionConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
This KMS key must have a policy that allows `kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect.   
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** sourceConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-sourceConfiguration"></a>
Source configuration information about the knowledge base.  
Type: [SourceConfiguration](API_amazon-q-connect_SourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** vectorIngestionConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseData-vectorIngestionConfiguration"></a>
Contains details about how to ingest the documents in a data source.  
Type: [VectorIngestionConfiguration](API_amazon-q-connect_VectorIngestionConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_KnowledgeBaseData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/KnowledgeBaseData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/KnowledgeBaseData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/KnowledgeBaseData) 

# KnowledgeBaseSummary
<a name="API_amazon-q-connect_KnowledgeBaseSummary"></a>

Summary information about the knowledge base.

## Contents
<a name="API_amazon-q-connect_KnowledgeBaseSummary_Contents"></a>

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** knowledgeBaseType **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-knowledgeBaseType"></a>
The type of knowledge base.  
Type: String  
Valid Values: `EXTERNAL | CUSTOM | QUICK_RESPONSES | MESSAGE_TEMPLATES | MANAGED`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-name"></a>
The name of the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-status"></a>
The status of the knowledge base summary.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED`   
Required: Yes

 ** description **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-description"></a>
The description of the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** renderingConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-renderingConfiguration"></a>
Information about how to render the content.  
Type: [RenderingConfiguration](API_amazon-q-connect_RenderingConfiguration.md) object  
Required: No

 ** serverSideEncryptionConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
This KMS key must have a policy that allows `kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect.   
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** sourceConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-sourceConfiguration"></a>
Configuration information about the external data source.  
Type: [SourceConfiguration](API_amazon-q-connect_SourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** vectorIngestionConfiguration **   <a name="connect-Type-amazon-q-connect_KnowledgeBaseSummary-vectorIngestionConfiguration"></a>
Contains details about how to ingest the documents in a data source.  
Type: [VectorIngestionConfiguration](API_amazon-q-connect_VectorIngestionConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_KnowledgeBaseSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/KnowledgeBaseSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/KnowledgeBaseSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/KnowledgeBaseSummary) 

# KnowledgeSource
<a name="API_amazon-q-connect_KnowledgeSource"></a>

A knowledge source that provides content for recommendations.

## Contents
<a name="API_amazon-q-connect_KnowledgeSource_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** assistantAssociationIds **   <a name="connect-Type-amazon-q-connect_KnowledgeSource-assistantAssociationIds"></a>
The list of assistant association identifiers for the knowledge source.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

## See Also
<a name="API_amazon-q-connect_KnowledgeSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/KnowledgeSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/KnowledgeSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/KnowledgeSource) 

# ManagedSourceConfiguration
<a name="API_amazon-q-connect_ManagedSourceConfiguration"></a>

Source configuration for managed resources.

## Contents
<a name="API_amazon-q-connect_ManagedSourceConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** webCrawlerConfiguration **   <a name="connect-Type-amazon-q-connect_ManagedSourceConfiguration-webCrawlerConfiguration"></a>
Configuration data for web crawler data source.  
Type: [WebCrawlerConfiguration](API_amazon-q-connect_WebCrawlerConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ManagedSourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ManagedSourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ManagedSourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ManagedSourceConfiguration) 

# ManualSearchAIAgentConfiguration
<a name="API_amazon-q-connect_ManualSearchAIAgentConfiguration"></a>

The configuration for the `MANUAL_SEARCH` AI Agent type.

## Contents
<a name="API_amazon-q-connect_ManualSearchAIAgentConfiguration_Contents"></a>

 ** answerGenerationAIGuardrailId **   <a name="connect-Type-amazon-q-connect_ManualSearchAIAgentConfiguration-answerGenerationAIGuardrailId"></a>
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL\$1SEARCH AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** answerGenerationAIPromptId **   <a name="connect-Type-amazon-q-connect_ManualSearchAIAgentConfiguration-answerGenerationAIPromptId"></a>
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL\$1SEARCH AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** associationConfigurations **   <a name="connect-Type-amazon-q-connect_ManualSearchAIAgentConfiguration-associationConfigurations"></a>
The association configurations for overriding behavior on this AI Agent.  
Type: Array of [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) objects  
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_ManualSearchAIAgentConfiguration-locale"></a>
The locale to which specifies the language and region settings that determine the response language for [QueryAssistant](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html).  
For more information on supported locales, see [Language support for Amazon Q in Connect](https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ManualSearchAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ManualSearchAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ManualSearchAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ManualSearchAIAgentConfiguration) 

# MessageConfiguration
<a name="API_amazon-q-connect_MessageConfiguration"></a>

The configuration for a [SendMessage](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html) request.

## Contents
<a name="API_amazon-q-connect_MessageConfiguration_Contents"></a>

 ** generateChunkedMessage **   <a name="connect-Type-amazon-q-connect_MessageConfiguration-generateChunkedMessage"></a>
Configuration for generating chunked messages.  
Type: Boolean  
Required: No

 ** generateFillerMessage **   <a name="connect-Type-amazon-q-connect_MessageConfiguration-generateFillerMessage"></a>
Generates a filler response when tool selection is `QUESTION`.  
Type: Boolean  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageConfiguration) 

# MessageData
<a name="API_amazon-q-connect_MessageData"></a>

The message data.

## Contents
<a name="API_amazon-q-connect_MessageData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="connect-Type-amazon-q-connect_MessageData-text"></a>
The message data in text type.  
Type: [TextMessage](API_amazon-q-connect_TextMessage.md) object  
Required: No

 ** toolUseResult **   <a name="connect-Type-amazon-q-connect_MessageData-toolUseResult"></a>
The result of tool usage in the message.  
Type: [ToolUseResultData](API_amazon-q-connect_ToolUseResultData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageData) 

# MessageInput
<a name="API_amazon-q-connect_MessageInput"></a>

The message input.

## Contents
<a name="API_amazon-q-connect_MessageInput_Contents"></a>

 ** value **   <a name="connect-Type-amazon-q-connect_MessageInput-value"></a>
The message input value.  
Type: [MessageData](API_amazon-q-connect_MessageData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_MessageInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageInput) 

# MessageOutput
<a name="API_amazon-q-connect_MessageOutput"></a>

The message output.

## Contents
<a name="API_amazon-q-connect_MessageOutput_Contents"></a>

 ** messageId **   <a name="connect-Type-amazon-q-connect_MessageOutput-messageId"></a>
The identifier of a message.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** participant **   <a name="connect-Type-amazon-q-connect_MessageOutput-participant"></a>
The participant of a message.  
Type: String  
Valid Values: `CUSTOMER | AGENT | BOT`   
Required: Yes

 ** timestamp **   <a name="connect-Type-amazon-q-connect_MessageOutput-timestamp"></a>
The timestamp of a message.  
Type: Timestamp  
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_MessageOutput-value"></a>
The value of a message data.  
Type: [MessageData](API_amazon-q-connect_MessageData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_MessageOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageOutput) 

# MessageTemplateAttachment
<a name="API_amazon-q-connect_MessageTemplateAttachment"></a>

Information about the message template attachment.

## Contents
<a name="API_amazon-q-connect_MessageTemplateAttachment_Contents"></a>

 ** attachmentId **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-attachmentId"></a>
The identifier of the attachment file.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentDisposition **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-contentDisposition"></a>
The presentation information for the attachment file.  
Type: String  
Valid Values: `ATTACHMENT`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-name"></a>
The name of the attachment file being uploaded. The name should include the file extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}_\s&@()+,;=\-]+\.[A-Za-z0-9]+`   
Required: Yes

 ** uploadedTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-uploadedTime"></a>
The timestamp when the attachment file was uploaded.  
Type: Timestamp  
Required: Yes

 ** url **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-url"></a>
A pre-signed Amazon S3 URL that can be used to download the attachment file.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** urlExpiry **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttachment-urlExpiry"></a>
The expiration time of the pre-signed Amazon S3 URL.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_amazon-q-connect_MessageTemplateAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateAttachment) 

# MessageTemplateAttributes
<a name="API_amazon-q-connect_MessageTemplateAttributes"></a>

The attributes that are used with the message template.

## Contents
<a name="API_amazon-q-connect_MessageTemplateAttributes_Contents"></a>

 ** agentAttributes **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttributes-agentAttributes"></a>
The agent attributes that are used with the message template.  
Type: [AgentAttributes](API_amazon-q-connect_AgentAttributes.md) object  
Required: No

 ** customAttributes **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttributes-customAttributes"></a>
The custom attributes that are used with the message template.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** customerProfileAttributes **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttributes-customerProfileAttributes"></a>
The customer profile attributes that are used with the message template.  
Type: [CustomerProfileAttributes](API_amazon-q-connect_CustomerProfileAttributes.md) object  
Required: No

 ** systemAttributes **   <a name="connect-Type-amazon-q-connect_MessageTemplateAttributes-systemAttributes"></a>
The system attributes that are used with the message template.  
Type: [SystemAttributes](API_amazon-q-connect_SystemAttributes.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateAttributes) 

# MessageTemplateBodyContentProvider
<a name="API_amazon-q-connect_MessageTemplateBodyContentProvider"></a>

The container of the message template body.

## Contents
<a name="API_amazon-q-connect_MessageTemplateBodyContentProvider_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** content **   <a name="connect-Type-amazon-q-connect_MessageTemplateBodyContentProvider-content"></a>
The content of the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateBodyContentProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateBodyContentProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateBodyContentProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateBodyContentProvider) 

# MessageTemplateContentProvider
<a name="API_amazon-q-connect_MessageTemplateContentProvider"></a>

The container of message template content.

## Contents
<a name="API_amazon-q-connect_MessageTemplateContentProvider_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** email **   <a name="connect-Type-amazon-q-connect_MessageTemplateContentProvider-email"></a>
The content of the message template that applies to the email channel subtype.  
Type: [EmailMessageTemplateContent](API_amazon-q-connect_EmailMessageTemplateContent.md) object  
Required: No

 ** push **   <a name="connect-Type-amazon-q-connect_MessageTemplateContentProvider-push"></a>
The content of the message template that applies to the push channel subtype.  
Type: [PushMessageTemplateContent](API_amazon-q-connect_PushMessageTemplateContent.md) object  
Required: No

 ** sms **   <a name="connect-Type-amazon-q-connect_MessageTemplateContentProvider-sms"></a>
The content of the message template that applies to the SMS channel subtype.  
Type: [SMSMessageTemplateContent](API_amazon-q-connect_SMSMessageTemplateContent.md) object  
Required: No

 ** whatsApp **   <a name="connect-Type-amazon-q-connect_MessageTemplateContentProvider-whatsApp"></a>
The content of the message template that applies to the WHATSAPP channel subtype.  
Type: [WhatsAppMessageTemplateContent](API_amazon-q-connect_WhatsAppMessageTemplateContent.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateContentProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateContentProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateContentProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateContentProvider) 

# MessageTemplateData
<a name="API_amazon-q-connect_MessageTemplateData"></a>

The data of a message template.

## Contents
<a name="API_amazon-q-connect_MessageTemplateData_Contents"></a>

 ** channelSubtype **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-createdTime"></a>
The timestamp when the message template was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the message template data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-lastModifiedTime"></a>
The timestamp when the message template data was last modified.  
Type: Timestamp  
Required: Yes

 ** messageTemplateArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** messageTemplateContentSha256 **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-messageTemplateContentSha256"></a>
The checksum value of the message template content that is referenced by the `$LATEST` qualifier. It can be returned in `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s calculated by content, language, `defaultAttributes` and `Attachments` of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+`   
Required: Yes

 ** messageTemplateId **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** attributeTypes **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-attributeTypes"></a>
The types of attributes that the message template contains.  
Type: Array of strings  
Valid Values: `SYSTEM | AGENT | CUSTOMER_PROFILE | CUSTOM`   
Required: No

 ** channel **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-channel"></a>
The channel of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** content **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-content"></a>
The content of the message template.  
Type: [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** defaultAttributes **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-defaultAttributes"></a>
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.  
Type: [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** groupingConfiguration **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-groupingConfiguration"></a>
The configuration information of the grouping of Amazon Q in Connect users.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** sourceConfigurationSummary **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-sourceConfigurationSummary"></a>
The source configuration summary of the message template.  
Type: [MessageTemplateSourceConfigurationSummary](API_amazon-q-connect_MessageTemplateSourceConfigurationSummary.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_MessageTemplateData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateData) 

# MessageTemplateFilterField
<a name="API_amazon-q-connect_MessageTemplateFilterField"></a>

The message template fields to filter the message template query results by. The following is the list of supported field names:
+ name
+ description
+ channel
+ channelSubtype
+ language
+ qualifier
+ createdTime
+ lastModifiedTime
+ lastModifiedBy
+ groupingConfiguration.criteria
+ groupingConfiguration.values

## Contents
<a name="API_amazon-q-connect_MessageTemplateFilterField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateFilterField-name"></a>
The name of the attribute field to filter the message templates by.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** operator **   <a name="connect-Type-amazon-q-connect_MessageTemplateFilterField-operator"></a>
The operator to use for filtering.  
Type: String  
Valid Values: `EQUALS | PREFIX`   
Required: Yes

 ** includeNoExistence **   <a name="connect-Type-amazon-q-connect_MessageTemplateFilterField-includeNoExistence"></a>
Whether to treat null value as a match for the attribute field.  
Type: Boolean  
Required: No

 ** values **   <a name="connect-Type-amazon-q-connect_MessageTemplateFilterField-values"></a>
The values of attribute field to filter the message template by.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateFilterField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateFilterField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateFilterField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateFilterField) 

# MessageTemplateOrderField
<a name="API_amazon-q-connect_MessageTemplateOrderField"></a>

The message template fields to order the message template query results by. The following is the list of supported field names:
+ name
+ description
+ channel
+ channelSubtype
+ language
+ qualifier
+ createdTime
+ lastModifiedTime
+ lastModifiedBy
+ groupingConfiguration.criteria
+ groupingConfiguration.values

## Contents
<a name="API_amazon-q-connect_MessageTemplateOrderField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateOrderField-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** order **   <a name="connect-Type-amazon-q-connect_MessageTemplateOrderField-order"></a>
The order at which the message templates are sorted by.  
Type: String  
Valid Values: `ASC | DESC`   
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateOrderField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateOrderField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateOrderField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateOrderField) 

# MessageTemplateQueryField
<a name="API_amazon-q-connect_MessageTemplateQueryField"></a>

The message template fields to query message templates by. The following is the list of supported field names:
+ name
+ description

## Contents
<a name="API_amazon-q-connect_MessageTemplateQueryField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateQueryField-name"></a>
The name of the attribute to query the message templates by.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** operator **   <a name="connect-Type-amazon-q-connect_MessageTemplateQueryField-operator"></a>
The operator to use for matching attribute field values in the query.  
Type: String  
Valid Values: `CONTAINS | CONTAINS_AND_PREFIX`   
Required: Yes

 ** values **   <a name="connect-Type-amazon-q-connect_MessageTemplateQueryField-values"></a>
The values of the attribute to query the message templates by.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** allowFuzziness **   <a name="connect-Type-amazon-q-connect_MessageTemplateQueryField-allowFuzziness"></a>
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.  
Type: Boolean  
Required: No

 ** priority **   <a name="connect-Type-amazon-q-connect_MessageTemplateQueryField-priority"></a>
The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.  
Type: String  
Valid Values: `HIGH | MEDIUM | LOW`   
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateQueryField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateQueryField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateQueryField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateQueryField) 

# MessageTemplateSearchExpression
<a name="API_amazon-q-connect_MessageTemplateSearchExpression"></a>

The search expression of the message template.

## Contents
<a name="API_amazon-q-connect_MessageTemplateSearchExpression_Contents"></a>

 ** filters **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchExpression-filters"></a>
The configuration of filtering rules applied to message template query results.  
Type: Array of [MessageTemplateFilterField](API_amazon-q-connect_MessageTemplateFilterField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** orderOnField **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchExpression-orderOnField"></a>
The message template attribute fields on which the query results are ordered.  
Type: [MessageTemplateOrderField](API_amazon-q-connect_MessageTemplateOrderField.md) object  
Required: No

 ** queries **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchExpression-queries"></a>
The message template query expressions.  
Type: Array of [MessageTemplateQueryField](API_amazon-q-connect_MessageTemplateQueryField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 4 items.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateSearchExpression_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateSearchExpression) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateSearchExpression) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateSearchExpression) 

# MessageTemplateSearchResultData
<a name="API_amazon-q-connect_MessageTemplateSearchResultData"></a>

The result of message template search.

## Contents
<a name="API_amazon-q-connect_MessageTemplateSearchResultData_Contents"></a>

 ** channelSubtype **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-createdTime"></a>
The timestamp when the message template was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the message template data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-lastModifiedTime"></a>
The timestamp when the message template data was last modified.  
Type: Timestamp  
Required: Yes

 ** messageTemplateArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** messageTemplateId **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** channel **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-channel"></a>
The channel of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** groupingConfiguration **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-groupingConfiguration"></a>
The configuration information of the grouping of Amazon Q in Connect users.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** isActive **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-isActive"></a>
Whether the version of the message template is activated.  
Type: Boolean  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** sourceConfigurationSummary **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-sourceConfigurationSummary"></a>
The source configuration summary of the message template.  
Type: [MessageTemplateSourceConfigurationSummary](API_amazon-q-connect_MessageTemplateSourceConfigurationSummary.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_MessageTemplateSearchResultData-versionNumber"></a>
The version number of the message template version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateSearchResultData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateSearchResultData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateSearchResultData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateSearchResultData) 

# MessageTemplateSourceConfiguration
<a name="API_amazon-q-connect_MessageTemplateSourceConfiguration"></a>

The container of message template source configuration.

## Contents
<a name="API_amazon-q-connect_MessageTemplateSourceConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** whatsApp **   <a name="connect-Type-amazon-q-connect_MessageTemplateSourceConfiguration-whatsApp"></a>
The sourceConfiguration of the message template that applies to the WHATSAPP channel subtype.  
Type: [WhatsAppMessageTemplateSourceConfiguration](API_amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateSourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateSourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateSourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateSourceConfiguration) 

# MessageTemplateSourceConfigurationSummary
<a name="API_amazon-q-connect_MessageTemplateSourceConfigurationSummary"></a>

The container of message template source configuration summary.

## Contents
<a name="API_amazon-q-connect_MessageTemplateSourceConfigurationSummary_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** whatsApp **   <a name="connect-Type-amazon-q-connect_MessageTemplateSourceConfigurationSummary-whatsApp"></a>
The sourceConfiguration summary of the message template that applies to the WHATSAPP channel subtype.  
Type: [WhatsAppMessageTemplateSourceConfigurationSummary](API_amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateSourceConfigurationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateSourceConfigurationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateSourceConfigurationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateSourceConfigurationSummary) 

# MessageTemplateSummary
<a name="API_amazon-q-connect_MessageTemplateSummary"></a>

The summary of the message template.

## Contents
<a name="API_amazon-q-connect_MessageTemplateSummary_Contents"></a>

 ** channelSubtype **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-createdTime"></a>
The timestamp when the message template was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the message template data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-lastModifiedTime"></a>
The timestamp when the message template data was last modified.  
Type: Timestamp  
Required: Yes

 ** messageTemplateArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** messageTemplateId **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** activeVersionNumber **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-activeVersionNumber"></a>
The version number of the message template version that is activated.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** channel **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-channel"></a>
The channel this message template applies to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** sourceConfiguration **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-sourceConfiguration"></a>
The container of message template source configuration.  
Type: [MessageTemplateSourceConfiguration](API_amazon-q-connect_MessageTemplateSourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_MessageTemplateSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateSummary) 

# MessageTemplateVersionSummary
<a name="API_amazon-q-connect_MessageTemplateVersionSummary"></a>

The summary of the message template version.

## Contents
<a name="API_amazon-q-connect_MessageTemplateVersionSummary_Contents"></a>

 ** channelSubtype **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** isActive **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-isActive"></a>
Whether the version of the message template is activated.  
Type: Boolean  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** messageTemplateArn **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** messageTemplateId **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** versionNumber **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-versionNumber"></a>
The version number of the message template version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** channel **   <a name="connect-Type-amazon-q-connect_MessageTemplateVersionSummary-channel"></a>
The channel of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

## See Also
<a name="API_amazon-q-connect_MessageTemplateVersionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/MessageTemplateVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/MessageTemplateVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/MessageTemplateVersionSummary) 

# NotesChunkDataDetails
<a name="API_amazon-q-connect_NotesChunkDataDetails"></a>

Details about notes chunk data.

## Contents
<a name="API_amazon-q-connect_NotesChunkDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_NotesChunkDataDetails-completion"></a>
A chunk of the notes completion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** nextChunkToken **   <a name="connect-Type-amazon-q-connect_NotesChunkDataDetails-nextChunkToken"></a>
The token for the next chunk of notes data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_NotesChunkDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/NotesChunkDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/NotesChunkDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/NotesChunkDataDetails) 

# NotesDataDetails
<a name="API_amazon-q-connect_NotesDataDetails"></a>

Details about notes data.

## Contents
<a name="API_amazon-q-connect_NotesDataDetails_Contents"></a>

 ** completion **   <a name="connect-Type-amazon-q-connect_NotesDataDetails-completion"></a>
The completion data for notes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_NotesDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/NotesDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/NotesDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/NotesDataDetails) 

# NoteTakingAIAgentConfiguration
<a name="API_amazon-q-connect_NoteTakingAIAgentConfiguration"></a>

The configuration for AI Agents of type `NOTE_TAKING`.

## Contents
<a name="API_amazon-q-connect_NoteTakingAIAgentConfiguration_Contents"></a>

 ** locale **   <a name="connect-Type-amazon-q-connect_NoteTakingAIAgentConfiguration-locale"></a>
The locale setting for language-specific case summarization generation (for example, en\$1US, es\$1ES).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** noteTakingAIGuardrailId **   <a name="connect-Type-amazon-q-connect_NoteTakingAIAgentConfiguration-noteTakingAIGuardrailId"></a>
The AI Guardrail identifier used by the Note Taking AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** noteTakingAIPromptId **   <a name="connect-Type-amazon-q-connect_NoteTakingAIAgentConfiguration-noteTakingAIPromptId"></a>
The AI Prompt identifier used by the Note Taking AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

## See Also
<a name="API_amazon-q-connect_NoteTakingAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/NoteTakingAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/NoteTakingAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/NoteTakingAIAgentConfiguration) 

# NotifyRecommendationsReceivedError
<a name="API_amazon-q-connect_NotifyRecommendationsReceivedError"></a>

An error occurred when creating a recommendation.

## Contents
<a name="API_amazon-q-connect_NotifyRecommendationsReceivedError_Contents"></a>

 ** message **   <a name="connect-Type-amazon-q-connect_NotifyRecommendationsReceivedError-message"></a>
A recommendation is causing an error.  
Type: String  
Required: No

 ** recommendationId **   <a name="connect-Type-amazon-q-connect_NotifyRecommendationsReceivedError-recommendationId"></a>
The identifier of the recommendation that is in error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_NotifyRecommendationsReceivedError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/NotifyRecommendationsReceivedError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/NotifyRecommendationsReceivedError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/NotifyRecommendationsReceivedError) 

# OrchestrationAIAgentConfiguration
<a name="API_amazon-q-connect_OrchestrationAIAgentConfiguration"></a>

The configuration for AI Agents of type `ORCHESTRATION`.

## Contents
<a name="API_amazon-q-connect_OrchestrationAIAgentConfiguration_Contents"></a>

 ** orchestrationAIPromptId **   <a name="connect-Type-amazon-q-connect_OrchestrationAIAgentConfiguration-orchestrationAIPromptId"></a>
The AI Prompt identifier used by the Orchestration AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** connectInstanceArn **   <a name="connect-Type-amazon-q-connect_OrchestrationAIAgentConfiguration-connectInstanceArn"></a>
The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** locale **   <a name="connect-Type-amazon-q-connect_OrchestrationAIAgentConfiguration-locale"></a>
The locale setting for the Orchestration AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** orchestrationAIGuardrailId **   <a name="connect-Type-amazon-q-connect_OrchestrationAIAgentConfiguration-orchestrationAIGuardrailId"></a>
The AI Guardrail identifier used by the Orchestration AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** toolConfigurations **   <a name="connect-Type-amazon-q-connect_OrchestrationAIAgentConfiguration-toolConfigurations"></a>
The tool configurations used by the Orchestration AI Agent.  
Type: Array of [ToolConfiguration](API_amazon-q-connect_ToolConfiguration.md) objects  
Required: No

## See Also
<a name="API_amazon-q-connect_OrchestrationAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/OrchestrationAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/OrchestrationAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/OrchestrationAIAgentConfiguration) 

# OrchestratorConfigurationEntry
<a name="API_amazon-q-connect_OrchestratorConfigurationEntry"></a>

An entry in the orchestrator configuration list.

## Contents
<a name="API_amazon-q-connect_OrchestratorConfigurationEntry_Contents"></a>

 ** orchestratorUseCase **   <a name="connect-Type-amazon-q-connect_OrchestratorConfigurationEntry-orchestratorUseCase"></a>
The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_OrchestratorConfigurationEntry-aiAgentId"></a>
The identifier of the AI Agent in the orchestrator configuration.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: No

## See Also
<a name="API_amazon-q-connect_OrchestratorConfigurationEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/OrchestratorConfigurationEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/OrchestratorConfigurationEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/OrchestratorConfigurationEntry) 

# OrCondition
<a name="API_amazon-q-connect_OrCondition"></a>

A list of conditions which would be applied together with an `OR` condition.

## Contents
<a name="API_amazon-q-connect_OrCondition_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** andConditions **   <a name="connect-Type-amazon-q-connect_OrCondition-andConditions"></a>
A list of conditions which would be applied together with an `AND` condition.  
Type: Array of [TagCondition](API_amazon-q-connect_TagCondition.md) objects  
Required: No

 ** tagCondition **   <a name="connect-Type-amazon-q-connect_OrCondition-tagCondition"></a>
A leaf node condition which can be used to specify a tag condition.  
Type: [TagCondition](API_amazon-q-connect_TagCondition.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_OrCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/OrCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/OrCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/OrCondition) 

# ParsingConfiguration
<a name="API_amazon-q-connect_ParsingConfiguration"></a>

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

## Contents
<a name="API_amazon-q-connect_ParsingConfiguration_Contents"></a>

 ** parsingStrategy **   <a name="connect-Type-amazon-q-connect_ParsingConfiguration-parsingStrategy"></a>
The parsing strategy for the data source.  
Type: String  
Valid Values: `BEDROCK_FOUNDATION_MODEL`   
Required: Yes

 ** bedrockFoundationModelConfiguration **   <a name="connect-Type-amazon-q-connect_ParsingConfiguration-bedrockFoundationModelConfiguration"></a>
Settings for a foundation model used to parse documents for a data source.  
Type: [BedrockFoundationModelConfigurationForParsing](API_amazon-q-connect_BedrockFoundationModelConfigurationForParsing.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ParsingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ParsingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ParsingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ParsingConfiguration) 

# ParsingPrompt
<a name="API_amazon-q-connect_ParsingPrompt"></a>

Instructions for interpreting the contents of a document.

## Contents
<a name="API_amazon-q-connect_ParsingPrompt_Contents"></a>

 ** parsingPromptText **   <a name="connect-Type-amazon-q-connect_ParsingPrompt-parsingPromptText"></a>
Instructions for interpreting the contents of a document.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_ParsingPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ParsingPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ParsingPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ParsingPrompt) 

# PushADMMessageTemplateContent
<a name="API_amazon-q-connect_PushADMMessageTemplateContent"></a>

The content of the push message template that applies to ADM (Amazon Device Messaging) notification service.

## Contents
<a name="API_amazon-q-connect_PushADMMessageTemplateContent_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-action"></a>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:  
+  `OPEN_APP` - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
+  `DEEP_LINK` - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
+  `URL` - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Type: String  
Valid Values: `OPEN_APP | DEEP_LINK | URL`   
Required: No

 ** body **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-body"></a>
The message body to use in a push notification that is based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** imageIconUrl **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-imageIconUrl"></a>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** imageUrl **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-imageUrl"></a>
The URL of an image to display in a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** rawContent **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-rawContent"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** smallImageIconUrl **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-smallImageIconUrl"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** sound **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-sound"></a>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-title"></a>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** url **   <a name="connect-Type-amazon-q-connect_PushADMMessageTemplateContent-url"></a>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `action` property is `URL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_PushADMMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PushADMMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PushADMMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PushADMMessageTemplateContent) 

# PushAPNSMessageTemplateContent
<a name="API_amazon-q-connect_PushAPNSMessageTemplateContent"></a>

The content of the push message template that applies to APNS (Apple Push Notification service) notification service.

## Contents
<a name="API_amazon-q-connect_PushAPNSMessageTemplateContent_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-action"></a>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:  
+  `OPEN_APP` - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
+  `DEEP_LINK` - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the iOS platform.
+  `URL` - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Type: String  
Valid Values: `OPEN_APP | DEEP_LINK | URL`   
Required: No

 ** body **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-body"></a>
The message body to use in a push notification that is based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** mediaUrl **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-mediaUrl"></a>
The URL of an image or video to display in push notifications that are based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** rawContent **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-rawContent"></a>
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** sound **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-sound"></a>
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the `Library/Sounds` folder in your app's data container. If the sound file can't be found or you specify `default` for the value, the system plays the default alert sound.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-title"></a>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** url **   <a name="connect-Type-amazon-q-connect_PushAPNSMessageTemplateContent-url"></a>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `action` property is `URL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_PushAPNSMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PushAPNSMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PushAPNSMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PushAPNSMessageTemplateContent) 

# PushBaiduMessageTemplateContent
<a name="API_amazon-q-connect_PushBaiduMessageTemplateContent"></a>

The content of the push message template that applies to Baidu notification service.

## Contents
<a name="API_amazon-q-connect_PushBaiduMessageTemplateContent_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-action"></a>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:  
+  `OPEN_APP` - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
+  `DEEP_LINK` - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
+  `URL` - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Type: String  
Valid Values: `OPEN_APP | DEEP_LINK | URL`   
Required: No

 ** body **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-body"></a>
The message body to use in a push notification that is based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** imageIconUrl **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-imageIconUrl"></a>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** imageUrl **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-imageUrl"></a>
The URL of an image to display in a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** rawContent **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-rawContent"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** smallImageIconUrl **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-smallImageIconUrl"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** sound **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-sound"></a>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-title"></a>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** url **   <a name="connect-Type-amazon-q-connect_PushBaiduMessageTemplateContent-url"></a>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `action` property is `URL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_PushBaiduMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PushBaiduMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PushBaiduMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PushBaiduMessageTemplateContent) 

# PushFCMMessageTemplateContent
<a name="API_amazon-q-connect_PushFCMMessageTemplateContent"></a>

The content of the push message template that applies to FCM (Firebase Cloud Messaging) notification service.

## Contents
<a name="API_amazon-q-connect_PushFCMMessageTemplateContent_Contents"></a>

 ** action **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-action"></a>
The action to occur if a recipient taps a push notification that is based on the message template. Valid values are:  
+  `OPEN_APP` - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
+  `DEEP_LINK` - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
+  `URL` - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Type: String  
Valid Values: `OPEN_APP | DEEP_LINK | URL`   
Required: No

 ** body **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-body"></a>
The message body to use in a push notification that is based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** imageIconUrl **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-imageIconUrl"></a>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** imageUrl **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-imageUrl"></a>
The URL of an image to display in a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** rawContent **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-rawContent"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** smallImageIconUrl **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-smallImageIconUrl"></a>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** sound **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-sound"></a>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-title"></a>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** url **   <a name="connect-Type-amazon-q-connect_PushFCMMessageTemplateContent-url"></a>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `action` property is `URL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_PushFCMMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PushFCMMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PushFCMMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PushFCMMessageTemplateContent) 

# PushMessageTemplateContent
<a name="API_amazon-q-connect_PushMessageTemplateContent"></a>

The content of the message template that applies to the push channel subtype.

## Contents
<a name="API_amazon-q-connect_PushMessageTemplateContent_Contents"></a>

 ** adm **   <a name="connect-Type-amazon-q-connect_PushMessageTemplateContent-adm"></a>
The content of the message template that applies to ADM (Amazon Device Messaging) notification service.  
Type: [PushADMMessageTemplateContent](API_amazon-q-connect_PushADMMessageTemplateContent.md) object  
Required: No

 ** apns **   <a name="connect-Type-amazon-q-connect_PushMessageTemplateContent-apns"></a>
The content of the message template that applies to APNS(Apple Push Notification service) notification service.  
Type: [PushAPNSMessageTemplateContent](API_amazon-q-connect_PushAPNSMessageTemplateContent.md) object  
Required: No

 ** baidu **   <a name="connect-Type-amazon-q-connect_PushMessageTemplateContent-baidu"></a>
The content of the message template that applies to Baidu notification service.  
Type: [PushBaiduMessageTemplateContent](API_amazon-q-connect_PushBaiduMessageTemplateContent.md) object  
Required: No

 ** fcm **   <a name="connect-Type-amazon-q-connect_PushMessageTemplateContent-fcm"></a>
The content of the message template that applies to FCM (Firebase Cloud Messaging) notification service.  
Type: [PushFCMMessageTemplateContent](API_amazon-q-connect_PushFCMMessageTemplateContent.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_PushMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PushMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PushMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PushMessageTemplateContent) 

# QueryCondition
<a name="API_amazon-q-connect_QueryCondition"></a>

Information about how to query content.

## Contents
<a name="API_amazon-q-connect_QueryCondition_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** single **   <a name="connect-Type-amazon-q-connect_QueryCondition-single"></a>
The condition for the query.  
Type: [QueryConditionItem](API_amazon-q-connect_QueryConditionItem.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_QueryCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryCondition) 

# QueryConditionItem
<a name="API_amazon-q-connect_QueryConditionItem"></a>

The condition for the query.

## Contents
<a name="API_amazon-q-connect_QueryConditionItem_Contents"></a>

 ** comparator **   <a name="connect-Type-amazon-q-connect_QueryConditionItem-comparator"></a>
The comparison operator for query condition to query on.  
Type: String  
Valid Values: `EQUALS`   
Required: Yes

 ** field **   <a name="connect-Type-amazon-q-connect_QueryConditionItem-field"></a>
 The name of the field for query condition to query on.  
Type: String  
Valid Values: `RESULT_TYPE`   
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_QueryConditionItem-value"></a>
The value for the query condition to query on.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_QueryConditionItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryConditionItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryConditionItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryConditionItem) 

# QueryInputData
<a name="API_amazon-q-connect_QueryInputData"></a>

Input information for the query.

## Contents
<a name="API_amazon-q-connect_QueryInputData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** caseSummarizationInputData **   <a name="connect-Type-amazon-q-connect_QueryInputData-caseSummarizationInputData"></a>
Input data for case summarization queries.  
Type: [CaseSummarizationInputData](API_amazon-q-connect_CaseSummarizationInputData.md) object  
Required: No

 ** intentInputData **   <a name="connect-Type-amazon-q-connect_QueryInputData-intentInputData"></a>
Input information for the intent.  
Type: [IntentInputData](API_amazon-q-connect_IntentInputData.md) object  
Required: No

 ** queryTextInputData **   <a name="connect-Type-amazon-q-connect_QueryInputData-queryTextInputData"></a>
Input information for the query.  
Type: [QueryTextInputData](API_amazon-q-connect_QueryTextInputData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_QueryInputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryInputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryInputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryInputData) 

# QueryRecommendationTriggerData
<a name="API_amazon-q-connect_QueryRecommendationTriggerData"></a>

Data associated with the QUERY RecommendationTriggerType.

## Contents
<a name="API_amazon-q-connect_QueryRecommendationTriggerData_Contents"></a>

 ** text **   <a name="connect-Type-amazon-q-connect_QueryRecommendationTriggerData-text"></a>
The text associated with the recommendation trigger.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: No

## See Also
<a name="API_amazon-q-connect_QueryRecommendationTriggerData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryRecommendationTriggerData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryRecommendationTriggerData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryRecommendationTriggerData) 

# QueryTextInputData
<a name="API_amazon-q-connect_QueryTextInputData"></a>

Information about the text to search for.

## Contents
<a name="API_amazon-q-connect_QueryTextInputData_Contents"></a>

 ** text **   <a name="connect-Type-amazon-q-connect_QueryTextInputData-text"></a>
The text to search for.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_QueryTextInputData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryTextInputData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryTextInputData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryTextInputData) 

# QuickResponseContentProvider
<a name="API_amazon-q-connect_QuickResponseContentProvider"></a>

The container quick response content.

## Contents
<a name="API_amazon-q-connect_QuickResponseContentProvider_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** content **   <a name="connect-Type-amazon-q-connect_QuickResponseContentProvider-content"></a>
The content of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseContentProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseContentProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseContentProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseContentProvider) 

# QuickResponseContents
<a name="API_amazon-q-connect_QuickResponseContents"></a>

The content of the quick response stored in different media types.

## Contents
<a name="API_amazon-q-connect_QuickResponseContents_Contents"></a>

 ** markdown **   <a name="connect-Type-amazon-q-connect_QuickResponseContents-markdown"></a>
The container quick response content.  
Type: [QuickResponseContentProvider](API_amazon-q-connect_QuickResponseContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** plainText **   <a name="connect-Type-amazon-q-connect_QuickResponseContents-plainText"></a>
The container quick response content.  
Type: [QuickResponseContentProvider](API_amazon-q-connect_QuickResponseContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseContents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseContents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseContents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseContents) 

# QuickResponseData
<a name="API_amazon-q-connect_QuickResponseData"></a>

Information about the quick response.

## Contents
<a name="API_amazon-q-connect_QuickResponseData_Contents"></a>

 ** contentType **   <a name="connect-Type-amazon-q-connect_QuickResponseData-contentType"></a>
The media type of the quick response content.  
+ Use `application/x.quickresponse;format=plain` for quick response written in plain text.
+ Use `application/x.quickresponse;format=markdown` for quick response written in richtext.
Type: String  
Pattern: `(application/x\.quickresponse;format=(plain|markdown))`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_QuickResponseData-createdTime"></a>
The timestamp when the quick response was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_QuickResponseData-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_QuickResponseData-lastModifiedTime"></a>
The timestamp when the quick response data was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseData-name"></a>
The name of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** quickResponseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseData-quickResponseArn"></a>
The Amazon Resource Name (ARN) of the quick response.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** quickResponseId **   <a name="connect-Type-amazon-q-connect_QuickResponseData-quickResponseId"></a>
The identifier of the quick response.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_QuickResponseData-status"></a>
The status of the quick response data.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_IN_PROGRESS | UPDATE_FAILED`   
Required: Yes

 ** channels **   <a name="connect-Type-amazon-q-connect_QuickResponseData-channels"></a>
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include `Chat`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** contents **   <a name="connect-Type-amazon-q-connect_QuickResponseData-contents"></a>
The contents of the quick response.  
Type: [QuickResponseContents](API_amazon-q-connect_QuickResponseContents.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_QuickResponseData-description"></a>
The description of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** groupingConfiguration **   <a name="connect-Type-amazon-q-connect_QuickResponseData-groupingConfiguration"></a>
The configuration information of the user groups that the quick response is accessible to.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** isActive **   <a name="connect-Type-amazon-q-connect_QuickResponseData-isActive"></a>
Whether the quick response is active.  
Type: Boolean  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_QuickResponseData-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_QuickResponseData-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the quick response data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** shortcutKey **   <a name="connect-Type-amazon-q-connect_QuickResponseData-shortcutKey"></a>
The shortcut key of the quick response. The value should be unique across the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_QuickResponseData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseData) 

# QuickResponseDataProvider
<a name="API_amazon-q-connect_QuickResponseDataProvider"></a>

The container of quick response data.

## Contents
<a name="API_amazon-q-connect_QuickResponseDataProvider_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** content **   <a name="connect-Type-amazon-q-connect_QuickResponseDataProvider-content"></a>
The content of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseDataProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseDataProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseDataProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseDataProvider) 

# QuickResponseFilterField
<a name="API_amazon-q-connect_QuickResponseFilterField"></a>

The quick response fields to filter the quick response query results by.

The following is the list of supported field names.
+ name
+ description
+ shortcutKey
+ isActive
+ channels
+ language
+ contentType
+ createdTime
+ lastModifiedTime
+ lastModifiedBy
+ groupingConfiguration.criteria
+ groupingConfiguration.values

## Contents
<a name="API_amazon-q-connect_QuickResponseFilterField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseFilterField-name"></a>
The name of the attribute field to filter the quick responses by.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** operator **   <a name="connect-Type-amazon-q-connect_QuickResponseFilterField-operator"></a>
The operator to use for filtering.  
Type: String  
Valid Values: `EQUALS | PREFIX`   
Required: Yes

 ** includeNoExistence **   <a name="connect-Type-amazon-q-connect_QuickResponseFilterField-includeNoExistence"></a>
Whether to treat null value as a match for the attribute field.  
Type: Boolean  
Required: No

 ** values **   <a name="connect-Type-amazon-q-connect_QuickResponseFilterField-values"></a>
The values of attribute field to filter the quick response by.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseFilterField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseFilterField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseFilterField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseFilterField) 

# QuickResponseOrderField
<a name="API_amazon-q-connect_QuickResponseOrderField"></a>

The quick response fields to order the quick response query results by.

The following is the list of supported field names.
+ name
+ description
+ shortcutKey
+ isActive
+ channels
+ language
+ contentType
+ createdTime
+ lastModifiedTime
+ lastModifiedBy
+ groupingConfiguration.criteria
+ groupingConfiguration.values

## Contents
<a name="API_amazon-q-connect_QuickResponseOrderField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseOrderField-name"></a>
The name of the attribute to order the quick response query results by.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** order **   <a name="connect-Type-amazon-q-connect_QuickResponseOrderField-order"></a>
The order at which the quick responses are sorted by.  
Type: String  
Valid Values: `ASC | DESC`   
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseOrderField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseOrderField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseOrderField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseOrderField) 

# QuickResponseQueryField
<a name="API_amazon-q-connect_QuickResponseQueryField"></a>

The quick response fields to query quick responses by.

The following is the list of supported field names.
+ content
+ name
+ description
+ shortcutKey

## Contents
<a name="API_amazon-q-connect_QuickResponseQueryField_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseQueryField-name"></a>
The name of the attribute to query the quick responses by.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** operator **   <a name="connect-Type-amazon-q-connect_QuickResponseQueryField-operator"></a>
The operator to use for matching attribute field values in the query.  
Type: String  
Valid Values: `CONTAINS | CONTAINS_AND_PREFIX`   
Required: Yes

 ** values **   <a name="connect-Type-amazon-q-connect_QuickResponseQueryField-values"></a>
The values of the attribute to query the quick responses by.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** allowFuzziness **   <a name="connect-Type-amazon-q-connect_QuickResponseQueryField-allowFuzziness"></a>
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.  
Type: Boolean  
Required: No

 ** priority **   <a name="connect-Type-amazon-q-connect_QuickResponseQueryField-priority"></a>
The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.  
Type: String  
Valid Values: `HIGH | MEDIUM | LOW`   
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseQueryField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseQueryField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseQueryField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseQueryField) 

# QuickResponseSearchExpression
<a name="API_amazon-q-connect_QuickResponseSearchExpression"></a>

Information about the import job.

## Contents
<a name="API_amazon-q-connect_QuickResponseSearchExpression_Contents"></a>

 ** filters **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchExpression-filters"></a>
The configuration of filtering rules applied to quick response query results.  
Type: Array of [QuickResponseFilterField](API_amazon-q-connect_QuickResponseFilterField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** orderOnField **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchExpression-orderOnField"></a>
The quick response attribute fields on which the query results are ordered.  
Type: [QuickResponseOrderField](API_amazon-q-connect_QuickResponseOrderField.md) object  
Required: No

 ** queries **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchExpression-queries"></a>
The quick response query expressions.  
Type: Array of [QuickResponseQueryField](API_amazon-q-connect_QuickResponseQueryField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 4 items.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseSearchExpression_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseSearchExpression) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseSearchExpression) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseSearchExpression) 

# QuickResponseSearchResultData
<a name="API_amazon-q-connect_QuickResponseSearchResultData"></a>

The result of quick response search.

## Contents
<a name="API_amazon-q-connect_QuickResponseSearchResultData_Contents"></a>

 ** contents **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-contents"></a>
The contents of the quick response.  
Type: [QuickResponseContents](API_amazon-q-connect_QuickResponseContents.md) object  
Required: Yes

 ** contentType **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-contentType"></a>
The media type of the quick response content.  
+ Use `application/x.quickresponse;format=plain` for quick response written in plain text.
+ Use `application/x.quickresponse;format=markdown` for quick response written in richtext.
Type: String  
Pattern: `(application/x\.quickresponse;format=(plain|markdown))`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-createdTime"></a>
The timestamp when the quick response was created.  
Type: Timestamp  
Required: Yes

 ** isActive **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-isActive"></a>
Whether the quick response is active.  
Type: Boolean  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-lastModifiedTime"></a>
The timestamp when the quick response search result data was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-name"></a>
The name of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** quickResponseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-quickResponseArn"></a>
The Amazon Resource Name (ARN) of the quick response.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** quickResponseId **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-quickResponseId"></a>
The identifier of the quick response.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-status"></a>
The resource status of the quick response.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_IN_PROGRESS | UPDATE_FAILED`   
Required: Yes

 ** attributesInterpolated **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-attributesInterpolated"></a>
The user defined contact attributes that are resolved when the search result is returned.  
Type: Array of strings  
Required: No

 ** attributesNotInterpolated **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-attributesNotInterpolated"></a>
The user defined contact attributes that are not resolved when the search result is returned.  
Type: Array of strings  
Required: No

 ** channels **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-channels"></a>
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include `Chat`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-description"></a>
The description of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** groupingConfiguration **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-groupingConfiguration"></a>
The configuration information of the user groups that the quick response is accessible to.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-language"></a>
The language code value for the language in which the quick response is written.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** shortcutKey **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-shortcutKey"></a>
The shortcut key of the quick response. The value should be unique across the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_QuickResponseSearchResultData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseSearchResultData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseSearchResultData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseSearchResultData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseSearchResultData) 

# QuickResponseSummary
<a name="API_amazon-q-connect_QuickResponseSummary"></a>

The summary information about the quick response.

## Contents
<a name="API_amazon-q-connect_QuickResponseSummary_Contents"></a>

 ** contentType **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-contentType"></a>
The media type of the quick response content.  
+ Use `application/x.quickresponse;format=plain` for quick response written in plain text.
+ Use `application/x.quickresponse;format=markdown` for quick response written in richtext.
Type: String  
Pattern: `(application/x\.quickresponse;format=(plain|markdown))`   
Required: Yes

 ** createdTime **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-createdTime"></a>
The timestamp when the quick response was created.  
Type: Timestamp  
Required: Yes

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** lastModifiedTime **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-lastModifiedTime"></a>
The timestamp when the quick response summary was last modified.  
Type: Timestamp  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-name"></a>
The name of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** quickResponseArn **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-quickResponseArn"></a>
The Amazon Resource Name (ARN) of the quick response.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** quickResponseId **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-quickResponseId"></a>
The identifier of the quick response.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-status"></a>
The resource status of the quick response.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATED | DELETE_IN_PROGRESS | DELETE_FAILED | DELETED | UPDATE_IN_PROGRESS | UPDATE_FAILED`   
Required: Yes

 ** channels **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-channels"></a>
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include `Chat`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-description"></a>
The description of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** isActive **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-isActive"></a>
Whether the quick response is active.  
Type: Boolean  
Required: No

 ** lastModifiedBy **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-lastModifiedBy"></a>
The Amazon Resource Name (ARN) of the user who last updated the quick response data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_QuickResponseSummary-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_QuickResponseSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QuickResponseSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QuickResponseSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QuickResponseSummary) 

# RankingData
<a name="API_amazon-q-connect_RankingData"></a>

Details about the source content ranking data.

## Contents
<a name="API_amazon-q-connect_RankingData_Contents"></a>

 ** relevanceLevel **   <a name="connect-Type-amazon-q-connect_RankingData-relevanceLevel"></a>
The relevance score of the content.  
Type: String  
Valid Values: `HIGH | MEDIUM | LOW`   
Required: No

 ** relevanceScore **   <a name="connect-Type-amazon-q-connect_RankingData-relevanceScore"></a>
The relevance level of the recommendation.  
Type: Double  
Valid Range: Minimum value of 0.0.  
Required: No

## See Also
<a name="API_amazon-q-connect_RankingData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RankingData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RankingData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RankingData) 

# RecommendationData
<a name="API_amazon-q-connect_RecommendationData"></a>

Information about the recommendation.

## Contents
<a name="API_amazon-q-connect_RecommendationData_Contents"></a>

 ** recommendationId **   <a name="connect-Type-amazon-q-connect_RecommendationData-recommendationId"></a>
The identifier of the recommendation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** data **   <a name="connect-Type-amazon-q-connect_RecommendationData-data"></a>
 Summary of the recommended content.  
Type: [DataSummary](API_amazon-q-connect_DataSummary.md) object  
Required: No

 ** document **   <a name="connect-Type-amazon-q-connect_RecommendationData-document"></a>
The recommended document.  
Type: [Document](API_amazon-q-connect_Document.md) object  
Required: No

 ** relevanceLevel **   <a name="connect-Type-amazon-q-connect_RecommendationData-relevanceLevel"></a>
The relevance level of the recommendation.  
Type: String  
Valid Values: `HIGH | MEDIUM | LOW`   
Required: No

 ** relevanceScore **   <a name="connect-Type-amazon-q-connect_RecommendationData-relevanceScore"></a>
The relevance score of the recommendation.  
Type: Double  
Valid Range: Minimum value of 0.0.  
Required: No

 ** type **   <a name="connect-Type-amazon-q-connect_RecommendationData-type"></a>
The type of recommendation.  
Type: String  
Valid Values: `KNOWLEDGE_CONTENT | GENERATIVE_RESPONSE | GENERATIVE_ANSWER | DETECTED_INTENT | GENERATIVE_ANSWER_CHUNK | BLOCKED_GENERATIVE_ANSWER_CHUNK | INTENT_ANSWER_CHUNK | BLOCKED_INTENT_ANSWER_CHUNK | EMAIL_RESPONSE_CHUNK | EMAIL_OVERVIEW_CHUNK | EMAIL_GENERATIVE_ANSWER_CHUNK | CASE_SUMMARIZATION_CHUNK | BLOCKED_CASE_SUMMARIZATION_CHUNK | SUGGESTED_MESSAGE | NOTES_CHUNK | BLOCKED_NOTES_CHUNK`   
Required: No

## See Also
<a name="API_amazon-q-connect_RecommendationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RecommendationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RecommendationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RecommendationData) 

# RecommendationTrigger
<a name="API_amazon-q-connect_RecommendationTrigger"></a>

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in `recommendationIds` by a single RecommendationTrigger.

## Contents
<a name="API_amazon-q-connect_RecommendationTrigger_Contents"></a>

 ** data **   <a name="connect-Type-amazon-q-connect_RecommendationTrigger-data"></a>
A union type containing information related to the trigger.  
Type: [RecommendationTriggerData](API_amazon-q-connect_RecommendationTriggerData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** id **   <a name="connect-Type-amazon-q-connect_RecommendationTrigger-id"></a>
The identifier of the recommendation trigger.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** recommendationIds **   <a name="connect-Type-amazon-q-connect_RecommendationTrigger-recommendationIds"></a>
The identifiers of the recommendations.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** source **   <a name="connect-Type-amazon-q-connect_RecommendationTrigger-source"></a>
The source of the recommendation trigger.  
+ ISSUE\$1DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
+ RULE\$1EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
Type: String  
Valid Values: `ISSUE_DETECTION | RULE_EVALUATION | OTHER`   
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_RecommendationTrigger-type"></a>
The type of recommendation trigger.  
Type: String  
Valid Values: `QUERY | GENERATIVE`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_RecommendationTrigger_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RecommendationTrigger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RecommendationTrigger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RecommendationTrigger) 

# RecommendationTriggerData
<a name="API_amazon-q-connect_RecommendationTriggerData"></a>

A union type containing information related to the trigger.

## Contents
<a name="API_amazon-q-connect_RecommendationTriggerData_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** query **   <a name="connect-Type-amazon-q-connect_RecommendationTriggerData-query"></a>
Data associated with the QUERY RecommendationTriggerType.  
Type: [QueryRecommendationTriggerData](API_amazon-q-connect_QueryRecommendationTriggerData.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_RecommendationTriggerData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RecommendationTriggerData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RecommendationTriggerData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RecommendationTriggerData) 

# RenderingConfiguration
<a name="API_amazon-q-connect_RenderingConfiguration"></a>

Information about how to render the content.

## Contents
<a name="API_amazon-q-connect_RenderingConfiguration_Contents"></a>

 ** templateUri **   <a name="connect-Type-amazon-q-connect_RenderingConfiguration-templateUri"></a>
A URI template containing exactly one variable in `${variableName} `format. This can only be set for `EXTERNAL` knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:  
+ Salesforce: `Id`, `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, or `IsDeleted` 
+ ServiceNow: `number`, `short_description`, `sys_mod_count`, `workflow_state`, or `active` 
+ Zendesk: `id`, `title`, `updated_at`, or `draft` 
The variable is replaced with the actual value for a piece of content when calling [GetContent](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_RenderingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RenderingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RenderingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RenderingConfiguration) 

# ResultData
<a name="API_amazon-q-connect_ResultData"></a>

Information about the result.

## Contents
<a name="API_amazon-q-connect_ResultData_Contents"></a>

 ** resultId **   <a name="connect-Type-amazon-q-connect_ResultData-resultId"></a>
The identifier of the result data.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** data **   <a name="connect-Type-amazon-q-connect_ResultData-data"></a>
 Summary of the recommended content.  
Type: [DataSummary](API_amazon-q-connect_DataSummary.md) object  
Required: No

 ** document **   <a name="connect-Type-amazon-q-connect_ResultData-document"></a>
The document.  
Type: [Document](API_amazon-q-connect_Document.md) object  
Required: No

 ** relevanceScore **   <a name="connect-Type-amazon-q-connect_ResultData-relevanceScore"></a>
The relevance score of the results.  
Type: Double  
Valid Range: Minimum value of 0.0.  
Required: No

 ** type **   <a name="connect-Type-amazon-q-connect_ResultData-type"></a>
The type of the query result.  
Type: String  
Valid Values: `KNOWLEDGE_CONTENT | INTENT_ANSWER | GENERATIVE_ANSWER | GENERATIVE_ANSWER_CHUNK | BLOCKED_GENERATIVE_ANSWER_CHUNK | INTENT_ANSWER_CHUNK | BLOCKED_INTENT_ANSWER_CHUNK | EMAIL_RESPONSE_CHUNK | EMAIL_OVERVIEW_CHUNK | EMAIL_GENERATIVE_ANSWER_CHUNK | CASE_SUMMARIZATION_CHUNK | BLOCKED_CASE_SUMMARIZATION_CHUNK | NOTES | NOTES_CHUNK | BLOCKED_NOTES_CHUNK`   
Required: No

## See Also
<a name="API_amazon-q-connect_ResultData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ResultData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ResultData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ResultData) 

# RetrievalConfiguration
<a name="API_amazon-q-connect_RetrievalConfiguration"></a>

Configuration for content retrieval operations.

## Contents
<a name="API_amazon-q-connect_RetrievalConfiguration_Contents"></a>

 ** knowledgeSource **   <a name="connect-Type-amazon-q-connect_RetrievalConfiguration-knowledgeSource"></a>
The knowledge source configuration for content retrieval.  
Type: [KnowledgeSource](API_amazon-q-connect_KnowledgeSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** filter **   <a name="connect-Type-amazon-q-connect_RetrievalConfiguration-filter"></a>
The filter configuration for content retrieval.  
Type: [RetrievalFilterConfiguration](API_amazon-q-connect_RetrievalFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** numberOfResults **   <a name="connect-Type-amazon-q-connect_RetrievalConfiguration-numberOfResults"></a>
The number of results to retrieve.  
Type: Integer  
Required: No

 ** overrideKnowledgeBaseSearchType **   <a name="connect-Type-amazon-q-connect_RetrievalConfiguration-overrideKnowledgeBaseSearchType"></a>
Override setting for the knowledge base search type during retrieval.  
Type: String  
Valid Values: `HYBRID | SEMANTIC`   
Required: No

## See Also
<a name="API_amazon-q-connect_RetrievalConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RetrievalConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RetrievalConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RetrievalConfiguration) 

# RetrievalFilterConfiguration
<a name="API_amazon-q-connect_RetrievalFilterConfiguration"></a>

Configuration for filtering content during retrieval operations.

## Contents
<a name="API_amazon-q-connect_RetrievalFilterConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** andAll **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-andAll"></a>
Filter configuration that requires all conditions to be met.  
Type: Array of [RetrievalFilterConfiguration](#API_amazon-q-connect_RetrievalFilterConfiguration) objects  
Array Members: Minimum number of 2 items.  
Required: No

 ** equals **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-equals"></a>
Filter configuration for exact equality matching.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** greaterThan **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-greaterThan"></a>
Filter configuration for greater than comparison.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** greaterThanOrEquals **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-greaterThanOrEquals"></a>
Filter configuration for greater than or equal comparison.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** in **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-in"></a>
Filter configuration for membership in a set of values.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** lessThan **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-lessThan"></a>
Filter configuration for less than comparison.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** lessThanOrEquals **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-lessThanOrEquals"></a>
Filter configuration for less than or equal comparison.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** listContains **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-listContains"></a>
Filter configuration for checking if a list contains a value.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** notEquals **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-notEquals"></a>
Filter configuration for inequality matching.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** notIn **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-notIn"></a>
Filter configuration for exclusion from a set of values.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** orAll **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-orAll"></a>
Filter configuration where any condition can be met.  
Type: Array of [RetrievalFilterConfiguration](#API_amazon-q-connect_RetrievalFilterConfiguration) objects  
Array Members: Minimum number of 2 items.  
Required: No

 ** startsWith **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-startsWith"></a>
Filter configuration for prefix matching.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

 ** stringContains **   <a name="connect-Type-amazon-q-connect_RetrievalFilterConfiguration-stringContains"></a>
Filter configuration for substring matching.  
Type: [FilterAttribute](API_amazon-q-connect_FilterAttribute.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_RetrievalFilterConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RetrievalFilterConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RetrievalFilterConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RetrievalFilterConfiguration) 

# RetrieveResult
<a name="API_amazon-q-connect_RetrieveResult"></a>

A single result from a content retrieval operation.

## Contents
<a name="API_amazon-q-connect_RetrieveResult_Contents"></a>

 ** associationId **   <a name="connect-Type-amazon-q-connect_RetrieveResult-associationId"></a>
The identifier of the assistant association for the retrieved result.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** contentText **   <a name="connect-Type-amazon-q-connect_RetrieveResult-contentText"></a>
The text content of the retrieved result.  
Type: String  
Required: Yes

 ** referenceType **   <a name="connect-Type-amazon-q-connect_RetrieveResult-referenceType"></a>
A type to define the KB origin of a retrieved content.  
Type: String  
Valid Values: `WEB_CRAWLER | KNOWLEDGE_BASE | BEDROCK_KB_S3 | BEDROCK_KB_WEB | BEDROCK_KB_CONFLUENCE | BEDROCK_KB_SALESFORCE | BEDROCK_KB_SHAREPOINT | BEDROCK_KB_KENDRA | BEDROCK_KB_CUSTOM_DOCUMENT | BEDROCK_KB_SQL`   
Required: Yes

 ** sourceId **   <a name="connect-Type-amazon-q-connect_RetrieveResult-sourceId"></a>
The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.  
Type: String  
Required: Yes

## See Also
<a name="API_amazon-q-connect_RetrieveResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RetrieveResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RetrieveResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RetrieveResult) 

# RuntimeSessionData
<a name="API_amazon-q-connect_RuntimeSessionData"></a>

The list of key-value pairs that are stored on the session.

## Contents
<a name="API_amazon-q-connect_RuntimeSessionData_Contents"></a>

 ** key **   <a name="connect-Type-amazon-q-connect_RuntimeSessionData-key"></a>
The key of the data stored on the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_RuntimeSessionData-value"></a>
The value of the data stored on the session.  
Type: [RuntimeSessionDataValue](API_amazon-q-connect_RuntimeSessionDataValue.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_RuntimeSessionData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RuntimeSessionData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RuntimeSessionData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RuntimeSessionData) 

# RuntimeSessionDataValue
<a name="API_amazon-q-connect_RuntimeSessionDataValue"></a>

A union type that specifies the data stored on the session.

## Contents
<a name="API_amazon-q-connect_RuntimeSessionDataValue_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** stringValue **   <a name="connect-Type-amazon-q-connect_RuntimeSessionDataValue-stringValue"></a>
The string value of the data stored on the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_RuntimeSessionDataValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RuntimeSessionDataValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RuntimeSessionDataValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RuntimeSessionDataValue) 

# SearchExpression
<a name="API_amazon-q-connect_SearchExpression"></a>

The search expression.

## Contents
<a name="API_amazon-q-connect_SearchExpression_Contents"></a>

 ** filters **   <a name="connect-Type-amazon-q-connect_SearchExpression-filters"></a>
The search expression filters.  
Type: Array of [Filter](API_amazon-q-connect_Filter.md) objects  
Required: Yes

## See Also
<a name="API_amazon-q-connect_SearchExpression_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SearchExpression) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SearchExpression) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SearchExpression) 

# SeedUrl
<a name="API_amazon-q-connect_SeedUrl"></a>

A URL for crawling.

## Contents
<a name="API_amazon-q-connect_SeedUrl_Contents"></a>

 ** url **   <a name="connect-Type-amazon-q-connect_SeedUrl-url"></a>
URL for crawling  
Type: String  
Pattern: `https?://[A-Za-z0-9][^\s]*`   
Required: No

## See Also
<a name="API_amazon-q-connect_SeedUrl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SeedUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SeedUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SeedUrl) 

# SelfServiceAIAgentConfiguration
<a name="API_amazon-q-connect_SelfServiceAIAgentConfiguration"></a>

The configuration for AI Agents of type SELF\$1SERVICE.

## Contents
<a name="API_amazon-q-connect_SelfServiceAIAgentConfiguration_Contents"></a>

 ** associationConfigurations **   <a name="connect-Type-amazon-q-connect_SelfServiceAIAgentConfiguration-associationConfigurations"></a>
The association configurations for overriding behavior on this AI Agent.  
Type: Array of [AssociationConfiguration](API_amazon-q-connect_AssociationConfiguration.md) objects  
Required: No

 ** selfServiceAIGuardrailId **   <a name="connect-Type-amazon-q-connect_SelfServiceAIAgentConfiguration-selfServiceAIGuardrailId"></a>
The AI Guardrail identifier used by the SELF\$1SERVICE AI Agent.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** selfServiceAnswerGenerationAIPromptId **   <a name="connect-Type-amazon-q-connect_SelfServiceAIAgentConfiguration-selfServiceAnswerGenerationAIPromptId"></a>
The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF\$1SERVICE AI Agent  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** selfServicePreProcessingAIPromptId **   <a name="connect-Type-amazon-q-connect_SelfServiceAIAgentConfiguration-selfServicePreProcessingAIPromptId"></a>
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF\$1SERVICE AI Agent  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}`   
Required: No

## See Also
<a name="API_amazon-q-connect_SelfServiceAIAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SelfServiceAIAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SelfServiceAIAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SelfServiceAIAgentConfiguration) 

# SelfServiceConversationHistory
<a name="API_amazon-q-connect_SelfServiceConversationHistory"></a>

The conversation history data to included in conversation context data before the Amazon Q in Connect session.

## Contents
<a name="API_amazon-q-connect_SelfServiceConversationHistory_Contents"></a>

 ** botResponse **   <a name="connect-Type-amazon-q-connect_SelfServiceConversationHistory-botResponse"></a>
The bot response of the conversation history data.  
Type: String  
Required: No

 ** inputTranscript **   <a name="connect-Type-amazon-q-connect_SelfServiceConversationHistory-inputTranscript"></a>
The input transcript of the conversation history data.  
Type: String  
Required: No

 ** timestamp **   <a name="connect-Type-amazon-q-connect_SelfServiceConversationHistory-timestamp"></a>
The timestamp of the conversation history entry.  
Type: Timestamp  
Required: No

 ** turnNumber **   <a name="connect-Type-amazon-q-connect_SelfServiceConversationHistory-turnNumber"></a>
The number of turn of the conversation history data.  
Type: Integer  
Required: No

## See Also
<a name="API_amazon-q-connect_SelfServiceConversationHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SelfServiceConversationHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SelfServiceConversationHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SelfServiceConversationHistory) 

# SemanticChunkingConfiguration
<a name="API_amazon-q-connect_SemanticChunkingConfiguration"></a>

Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.

## Contents
<a name="API_amazon-q-connect_SemanticChunkingConfiguration_Contents"></a>

 ** breakpointPercentileThreshold **   <a name="connect-Type-amazon-q-connect_SemanticChunkingConfiguration-breakpointPercentileThreshold"></a>
The dissimilarity threshold for splitting chunks.  
Type: Integer  
Valid Range: Minimum value of 50. Maximum value of 99.  
Required: Yes

 ** bufferSize **   <a name="connect-Type-amazon-q-connect_SemanticChunkingConfiguration-bufferSize"></a>
The buffer size.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

 ** maxTokens **   <a name="connect-Type-amazon-q-connect_SemanticChunkingConfiguration-maxTokens"></a>
The maximum number of tokens that a chunk can contain.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_SemanticChunkingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SemanticChunkingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SemanticChunkingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SemanticChunkingConfiguration) 

# ServerSideEncryptionConfiguration
<a name="API_amazon-q-connect_ServerSideEncryptionConfiguration"></a>

The configuration information for the customer managed key used for encryption.

## Contents
<a name="API_amazon-q-connect_ServerSideEncryptionConfiguration_Contents"></a>

 ** kmsKeyId **   <a name="connect-Type-amazon-q-connect_ServerSideEncryptionConfiguration-kmsKeyId"></a>
The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html). For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ServerSideEncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ServerSideEncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ServerSideEncryptionConfiguration) 

# SessionData
<a name="API_amazon-q-connect_SessionData"></a>

Information about the session.

## Contents
<a name="API_amazon-q-connect_SessionData_Contents"></a>

 ** name **   <a name="connect-Type-amazon-q-connect_SessionData-name"></a>
The name of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** sessionArn **   <a name="connect-Type-amazon-q-connect_SessionData-sessionArn"></a>
The Amazon Resource Name (ARN) of the session.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** sessionId **   <a name="connect-Type-amazon-q-connect_SessionData-sessionId"></a>
The identifier of the session.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** aiAgentConfiguration **   <a name="connect-Type-amazon-q-connect_SessionData-aiAgentConfiguration"></a>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.  
Type: String to [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object map  
Valid Keys: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_SessionData-description"></a>
The description of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** integrationConfiguration **   <a name="connect-Type-amazon-q-connect_SessionData-integrationConfiguration"></a>
The configuration information for the session integration.  
Type: [SessionIntegrationConfiguration](API_amazon-q-connect_SessionIntegrationConfiguration.md) object  
Required: No

 ** orchestratorConfigurationList **   <a name="connect-Type-amazon-q-connect_SessionData-orchestratorConfigurationList"></a>
The list of orchestrator configurations for the session.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

 ** origin **   <a name="connect-Type-amazon-q-connect_SessionData-origin"></a>
The origin of the Session to be listed. `SYSTEM` for a default Session created by Amazon Q in Connect or `CUSTOMER` for a Session created by calling [CreateSession](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_CreateSession.html) API.  
Type: String  
Valid Values: `SYSTEM | CUSTOMER`   
Required: No

 ** tagFilter **   <a name="connect-Type-amazon-q-connect_SessionData-tagFilter"></a>
An object that can be used to specify Tag conditions.  
Type: [TagFilter](API_amazon-q-connect_TagFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** tags **   <a name="connect-Type-amazon-q-connect_SessionData-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_SessionData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SessionData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SessionData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SessionData) 

# SessionIntegrationConfiguration
<a name="API_amazon-q-connect_SessionIntegrationConfiguration"></a>

The configuration information for the session integration.

## Contents
<a name="API_amazon-q-connect_SessionIntegrationConfiguration_Contents"></a>

 ** topicIntegrationArn **   <a name="connect-Type-amazon-q-connect_SessionIntegrationConfiguration-topicIntegrationArn"></a>
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

## See Also
<a name="API_amazon-q-connect_SessionIntegrationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SessionIntegrationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SessionIntegrationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SessionIntegrationConfiguration) 

# SessionSummary
<a name="API_amazon-q-connect_SessionSummary"></a>

Summary information about the session.

## Contents
<a name="API_amazon-q-connect_SessionSummary_Contents"></a>

 ** assistantArn **   <a name="connect-Type-amazon-q-connect_SessionSummary-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** assistantId **   <a name="connect-Type-amazon-q-connect_SessionSummary-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** sessionArn **   <a name="connect-Type-amazon-q-connect_SessionSummary-sessionArn"></a>
The Amazon Resource Name (ARN) of the session.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** sessionId **   <a name="connect-Type-amazon-q-connect_SessionSummary-sessionId"></a>
The identifier of the session.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_SessionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SessionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SessionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SessionSummary) 

# SMSMessageTemplateContent
<a name="API_amazon-q-connect_SMSMessageTemplateContent"></a>

The content of the message template that applies to the SMS channel subtype.

## Contents
<a name="API_amazon-q-connect_SMSMessageTemplateContent_Contents"></a>

 ** body **   <a name="connect-Type-amazon-q-connect_SMSMessageTemplateContent-body"></a>
The body to use in SMS messages.  
Type: [SMSMessageTemplateContentBody](API_amazon-q-connect_SMSMessageTemplateContentBody.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_SMSMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SMSMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SMSMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SMSMessageTemplateContent) 

# SMSMessageTemplateContentBody
<a name="API_amazon-q-connect_SMSMessageTemplateContentBody"></a>

The body to use in SMS messages.

## Contents
<a name="API_amazon-q-connect_SMSMessageTemplateContentBody_Contents"></a>

 ** plainText **   <a name="connect-Type-amazon-q-connect_SMSMessageTemplateContentBody-plainText"></a>
The message body to use in SMS messages.  
Type: [MessageTemplateBodyContentProvider](API_amazon-q-connect_MessageTemplateBodyContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_amazon-q-connect_SMSMessageTemplateContentBody_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SMSMessageTemplateContentBody) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SMSMessageTemplateContentBody) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SMSMessageTemplateContentBody) 

# SourceConfiguration
<a name="API_amazon-q-connect_SourceConfiguration"></a>

Configuration information about the external data source.

## Contents
<a name="API_amazon-q-connect_SourceConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** appIntegrations **   <a name="connect-Type-amazon-q-connect_SourceConfiguration-appIntegrations"></a>
Configuration information for Amazon AppIntegrations to automatically ingest content.  
Type: [AppIntegrationsConfiguration](API_amazon-q-connect_AppIntegrationsConfiguration.md) object  
Required: No

 ** managedSourceConfiguration **   <a name="connect-Type-amazon-q-connect_SourceConfiguration-managedSourceConfiguration"></a>
Source configuration for managed resources.  
Type: [ManagedSourceConfiguration](API_amazon-q-connect_ManagedSourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## See Also
<a name="API_amazon-q-connect_SourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SourceConfiguration) 

# SourceContentDataDetails
<a name="API_amazon-q-connect_SourceContentDataDetails"></a>

Details about the source content data.

## Contents
<a name="API_amazon-q-connect_SourceContentDataDetails_Contents"></a>

 ** id **   <a name="connect-Type-amazon-q-connect_SourceContentDataDetails-id"></a>
The identifier of the source content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** rankingData **   <a name="connect-Type-amazon-q-connect_SourceContentDataDetails-rankingData"></a>
Details about the source content ranking data.  
Type: [RankingData](API_amazon-q-connect_RankingData.md) object  
Required: Yes

 ** textData **   <a name="connect-Type-amazon-q-connect_SourceContentDataDetails-textData"></a>
 Details about the source content text data.  
Type: [TextData](API_amazon-q-connect_TextData.md) object  
Required: Yes

 ** type **   <a name="connect-Type-amazon-q-connect_SourceContentDataDetails-type"></a>
The type of the source content.  
Type: String  
Valid Values: `KNOWLEDGE_CONTENT`   
Required: Yes

 ** citationSpan **   <a name="connect-Type-amazon-q-connect_SourceContentDataDetails-citationSpan"></a>
Contains information about where the text with a citation begins and ends in the generated output.  
Type: [CitationSpan](API_amazon-q-connect_CitationSpan.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_SourceContentDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SourceContentDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SourceContentDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SourceContentDataDetails) 

# Span
<a name="API_amazon-q-connect_Span"></a>

A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.

## Contents
<a name="API_amazon-q-connect_Span_Contents"></a>

 ** assistantId **   <a name="connect-Type-amazon-q-connect_Span-assistantId"></a>
UUID of the Connect AI Assistant resource  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** attributes **   <a name="connect-Type-amazon-q-connect_Span-attributes"></a>
Span-specific contextual attributes  
Type: [SpanAttributes](API_amazon-q-connect_SpanAttributes.md) object  
Required: Yes

 ** endTimestamp **   <a name="connect-Type-amazon-q-connect_Span-endTimestamp"></a>
Operation end time in milliseconds since epoch  
Type: Timestamp  
Required: Yes

 ** requestId **   <a name="connect-Type-amazon-q-connect_Span-requestId"></a>
The service request ID that initiated the operation  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** sessionId **   <a name="connect-Type-amazon-q-connect_Span-sessionId"></a>
UUID of the Connect AI Session resource  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** spanId **   <a name="connect-Type-amazon-q-connect_Span-spanId"></a>
Unique span identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** spanName **   <a name="connect-Type-amazon-q-connect_Span-spanName"></a>
Service-defined operation name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** spanType **   <a name="connect-Type-amazon-q-connect_Span-spanType"></a>
Operation relationship type  
Type: String  
Valid Values: `CLIENT | SERVER | INTERNAL`   
Required: Yes

 ** startTimestamp **   <a name="connect-Type-amazon-q-connect_Span-startTimestamp"></a>
Operation start time in milliseconds since epoch  
Type: Timestamp  
Required: Yes

 ** status **   <a name="connect-Type-amazon-q-connect_Span-status"></a>
Span completion status  
Type: String  
Valid Values: `OK | ERROR | TIMEOUT`   
Required: Yes

 ** parentSpanId **   <a name="connect-Type-amazon-q-connect_Span-parentSpanId"></a>
Parent span identifier for hierarchy. Null for root spans.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

## See Also
<a name="API_amazon-q-connect_Span_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Span) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Span) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Span) 

# SpanAttributes
<a name="API_amazon-q-connect_SpanAttributes"></a>

Contextual attributes capturing operation details, LLM configuration, usage metrics, and conversation data

## Contents
<a name="API_amazon-q-connect_SpanAttributes_Contents"></a>

 ** agentId **   <a name="connect-Type-amazon-q-connect_SpanAttributes-agentId"></a>
Amazon Connect agent ID  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** aiAgentArn **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentArn"></a>
AI agent ARN  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentId"></a>
AI agent identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** aiAgentInvoker **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentInvoker"></a>
Entity that invoked the AI agent  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** aiAgentName **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentName"></a>
AI agent name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** aiAgentOrchestratorUseCase **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentOrchestratorUseCase"></a>
AI agent orchestrator use case  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** aiAgentType **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentType"></a>
AI agent type  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** aiAgentVersion **   <a name="connect-Type-amazon-q-connect_SpanAttributes-aiAgentVersion"></a>
AI agent version number  
Type: Integer  
Required: No

 ** cacheReadInputTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-cacheReadInputTokens"></a>
Number of input tokens that were retrieved from cache  
Type: Integer  
Required: No

 ** cacheWriteInputTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-cacheWriteInputTokens"></a>
Number of input tokens that were written to cache in this request  
Type: Integer  
Required: No

 ** contactId **   <a name="connect-Type-amazon-q-connect_SpanAttributes-contactId"></a>
Amazon Connect contact identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** errorType **   <a name="connect-Type-amazon-q-connect_SpanAttributes-errorType"></a>
Error classification if span failed (e.g., throttle, timeout)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** initialContactId **   <a name="connect-Type-amazon-q-connect_SpanAttributes-initialContactId"></a>
Amazon Connect contact identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** inputMessages **   <a name="connect-Type-amazon-q-connect_SpanAttributes-inputMessages"></a>
Input message collection sent to LLM  
Type: Array of [SpanMessage](API_amazon-q-connect_SpanMessage.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** instanceArn **   <a name="connect-Type-amazon-q-connect_SpanAttributes-instanceArn"></a>
Amazon Connect instance ARN  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** operationName **   <a name="connect-Type-amazon-q-connect_SpanAttributes-operationName"></a>
Action being performed  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** outputMessages **   <a name="connect-Type-amazon-q-connect_SpanAttributes-outputMessages"></a>
Output message collection received from LLM  
Type: Array of [SpanMessage](API_amazon-q-connect_SpanMessage.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** promptArn **   <a name="connect-Type-amazon-q-connect_SpanAttributes-promptArn"></a>
AI prompt ARN  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** promptId **   <a name="connect-Type-amazon-q-connect_SpanAttributes-promptId"></a>
AI prompt identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** promptName **   <a name="connect-Type-amazon-q-connect_SpanAttributes-promptName"></a>
AI prompt name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** promptType **   <a name="connect-Type-amazon-q-connect_SpanAttributes-promptType"></a>
AI prompt type  
Type: String  
Valid Values: `ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** promptVersion **   <a name="connect-Type-amazon-q-connect_SpanAttributes-promptVersion"></a>
AI prompt version number  
Type: Integer  
Required: No

 ** providerName **   <a name="connect-Type-amazon-q-connect_SpanAttributes-providerName"></a>
Model provider identifier (e.g., aws.bedrock)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** requestMaxTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-requestMaxTokens"></a>
Maximum tokens configured for generation  
Type: Integer  
Required: No

 ** requestModel **   <a name="connect-Type-amazon-q-connect_SpanAttributes-requestModel"></a>
LLM model ID for request (e.g., anthropic.claude-3-sonnet)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** responseFinishReasons **   <a name="connect-Type-amazon-q-connect_SpanAttributes-responseFinishReasons"></a>
Generation termination reasons (e.g., stop, max\$1tokens)  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** responseModel **   <a name="connect-Type-amazon-q-connect_SpanAttributes-responseModel"></a>
Actual model used for response (usually matches requestModel)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** sessionName **   <a name="connect-Type-amazon-q-connect_SpanAttributes-sessionName"></a>
Session name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** systemInstructions **   <a name="connect-Type-amazon-q-connect_SpanAttributes-systemInstructions"></a>
System prompt instructions  
Type: Array of [SpanMessageValue](API_amazon-q-connect_SpanMessageValue.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** temperature **   <a name="connect-Type-amazon-q-connect_SpanAttributes-temperature"></a>
Sampling temperature for generation  
Type: Float  
Valid Range: Minimum value of 0.0. Maximum value of 1.0.  
Required: No

 ** topP **   <a name="connect-Type-amazon-q-connect_SpanAttributes-topP"></a>
Top-p sampling parameter for generation  
Type: Float  
Valid Range: Minimum value of 0.0. Maximum value of 1.0.  
Required: No

 ** usageInputTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-usageInputTokens"></a>
Number of input tokens in prompt  
Type: Integer  
Required: No

 ** usageOutputTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-usageOutputTokens"></a>
Number of output tokens in response  
Type: Integer  
Required: No

 ** usageTotalTokens **   <a name="connect-Type-amazon-q-connect_SpanAttributes-usageTotalTokens"></a>
Total tokens consumed (input \$1 output)  
Type: Integer  
Required: No

## See Also
<a name="API_amazon-q-connect_SpanAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanAttributes) 

# SpanCitation
<a name="API_amazon-q-connect_SpanCitation"></a>

A citation that spans a specific range of text.

## Contents
<a name="API_amazon-q-connect_SpanCitation_Contents"></a>

 ** contentId **   <a name="connect-Type-amazon-q-connect_SpanCitation-contentId"></a>
The identifier of the content being cited in the span.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** knowledgeBaseArn **   <a name="connect-Type-amazon-q-connect_SpanCitation-knowledgeBaseArn"></a>
The Amazon Resource Name (ARN) of the knowledge base containing the cited content.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

 ** knowledgeBaseId **   <a name="connect-Type-amazon-q-connect_SpanCitation-knowledgeBaseId"></a>
The identifier of the knowledge base containing the cited content.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_SpanCitation-title"></a>
The title of the content being cited in the span.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_SpanCitation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanCitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanCitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanCitation) 

# SpanMessage
<a name="API_amazon-q-connect_SpanMessage"></a>

A message in the conversation history with participant role and content values

## Contents
<a name="API_amazon-q-connect_SpanMessage_Contents"></a>

 ** messageId **   <a name="connect-Type-amazon-q-connect_SpanMessage-messageId"></a>
Unique message identifier  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** participant **   <a name="connect-Type-amazon-q-connect_SpanMessage-participant"></a>
Message source role  
Type: String  
Valid Values: `CUSTOMER | AGENT | BOT`   
Required: Yes

 ** timestamp **   <a name="connect-Type-amazon-q-connect_SpanMessage-timestamp"></a>
Message timestamp  
Type: Timestamp  
Required: Yes

 ** values **   <a name="connect-Type-amazon-q-connect_SpanMessage-values"></a>
Message content values (text, tool use, tool result)  
Type: Array of [SpanMessageValue](API_amazon-q-connect_SpanMessageValue.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_SpanMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanMessage) 

# SpanMessageValue
<a name="API_amazon-q-connect_SpanMessageValue"></a>

Message content value - can be text, tool invocation, or tool result

## Contents
<a name="API_amazon-q-connect_SpanMessageValue_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** text **   <a name="connect-Type-amazon-q-connect_SpanMessageValue-text"></a>
Text message content  
Type: [SpanTextValue](API_amazon-q-connect_SpanTextValue.md) object  
Required: No

 ** toolResult **   <a name="connect-Type-amazon-q-connect_SpanMessageValue-toolResult"></a>
Tool result message content  
Type: [SpanToolResultValue](API_amazon-q-connect_SpanToolResultValue.md) object  
Required: No

 ** toolUse **   <a name="connect-Type-amazon-q-connect_SpanMessageValue-toolUse"></a>
Tool invocation message content  
Type: [SpanToolUseValue](API_amazon-q-connect_SpanToolUseValue.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_SpanMessageValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanMessageValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanMessageValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanMessageValue) 

# SpanTextValue
<a name="API_amazon-q-connect_SpanTextValue"></a>

Text message content

## Contents
<a name="API_amazon-q-connect_SpanTextValue_Contents"></a>

 ** value **   <a name="connect-Type-amazon-q-connect_SpanTextValue-value"></a>
String content of the message text  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** aiGuardrailAssessment **   <a name="connect-Type-amazon-q-connect_SpanTextValue-aiGuardrailAssessment"></a>
The AI Guardrail assessment for the span text.  
Type: [AIGuardrailAssessment](API_amazon-q-connect_AIGuardrailAssessment.md) object  
Required: No

 ** citations **   <a name="connect-Type-amazon-q-connect_SpanTextValue-citations"></a>
The citations associated with the span text.  
Type: Array of [SpanCitation](API_amazon-q-connect_SpanCitation.md) objects  
Required: No

## See Also
<a name="API_amazon-q-connect_SpanTextValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanTextValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanTextValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanTextValue) 

# SpanToolResultValue
<a name="API_amazon-q-connect_SpanToolResultValue"></a>

Tool result message content

## Contents
<a name="API_amazon-q-connect_SpanToolResultValue_Contents"></a>

 ** toolUseId **   <a name="connect-Type-amazon-q-connect_SpanToolResultValue-toolUseId"></a>
Relates this result back to the tool invocation  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** values **   <a name="connect-Type-amazon-q-connect_SpanToolResultValue-values"></a>
The tool results  
Type: Array of [SpanMessageValue](API_amazon-q-connect_SpanMessageValue.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** error **   <a name="connect-Type-amazon-q-connect_SpanToolResultValue-error"></a>
The tool invocation error if failed  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_SpanToolResultValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanToolResultValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanToolResultValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanToolResultValue) 

# SpanToolUseValue
<a name="API_amazon-q-connect_SpanToolUseValue"></a>

Tool invocation message content

## Contents
<a name="API_amazon-q-connect_SpanToolUseValue_Contents"></a>

 ** arguments **   <a name="connect-Type-amazon-q-connect_SpanToolUseValue-arguments"></a>
The tool input arguments  
Type: JSON value  
Required: Yes

 ** name **   <a name="connect-Type-amazon-q-connect_SpanToolUseValue-name"></a>
The tool name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** toolUseId **   <a name="connect-Type-amazon-q-connect_SpanToolUseValue-toolUseId"></a>
Unique ID for this tool invocation  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_SpanToolUseValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SpanToolUseValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SpanToolUseValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SpanToolUseValue) 

# SuggestedMessageDataDetails
<a name="API_amazon-q-connect_SuggestedMessageDataDetails"></a>

Details about suggested message data.

## Contents
<a name="API_amazon-q-connect_SuggestedMessageDataDetails_Contents"></a>

 ** messageText **   <a name="connect-Type-amazon-q-connect_SuggestedMessageDataDetails-messageText"></a>
The text content of the suggested message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_SuggestedMessageDataDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SuggestedMessageDataDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SuggestedMessageDataDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SuggestedMessageDataDetails) 

# SuggestedMessageReference
<a name="API_amazon-q-connect_SuggestedMessageReference"></a>

Reference information for a suggested message.

## Contents
<a name="API_amazon-q-connect_SuggestedMessageReference_Contents"></a>

 ** aiAgentArn **   <a name="connect-Type-amazon-q-connect_SuggestedMessageReference-aiAgentArn"></a>
The Amazon Resource Name (ARN) of the AI Agent that generated the suggested message.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** aiAgentId **   <a name="connect-Type-amazon-q-connect_SuggestedMessageReference-aiAgentId"></a>
The identifier of the AI Agent that generated the suggested message.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## See Also
<a name="API_amazon-q-connect_SuggestedMessageReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SuggestedMessageReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SuggestedMessageReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SuggestedMessageReference) 

# SystemAttributes
<a name="API_amazon-q-connect_SystemAttributes"></a>

The system attributes that are used with the message template.

## Contents
<a name="API_amazon-q-connect_SystemAttributes_Contents"></a>

 ** customerEndpoint **   <a name="connect-Type-amazon-q-connect_SystemAttributes-customerEndpoint"></a>
The CustomerEndpoint attribute.  
Type: [SystemEndpointAttributes](API_amazon-q-connect_SystemEndpointAttributes.md) object  
Required: No

 ** name **   <a name="connect-Type-amazon-q-connect_SystemAttributes-name"></a>
The name of the task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

 ** systemEndpoint **   <a name="connect-Type-amazon-q-connect_SystemAttributes-systemEndpoint"></a>
The SystemEndpoint attribute.  
Type: [SystemEndpointAttributes](API_amazon-q-connect_SystemEndpointAttributes.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_SystemAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SystemAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SystemAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SystemAttributes) 

# SystemEndpointAttributes
<a name="API_amazon-q-connect_SystemEndpointAttributes"></a>

The system endpoint attributes that are used with the message template.

## Contents
<a name="API_amazon-q-connect_SystemEndpointAttributes_Contents"></a>

 ** address **   <a name="connect-Type-amazon-q-connect_SystemEndpointAttributes-address"></a>
The customer's phone number if used with `customerEndpoint`, or the number the customer dialed to call your contact center if used with `systemEndpoint`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32767.  
Required: No

## See Also
<a name="API_amazon-q-connect_SystemEndpointAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SystemEndpointAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SystemEndpointAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SystemEndpointAttributes) 

# TagCondition
<a name="API_amazon-q-connect_TagCondition"></a>

A leaf node condition which can be used to specify a tag condition. 

## Contents
<a name="API_amazon-q-connect_TagCondition_Contents"></a>

 ** key **   <a name="connect-Type-amazon-q-connect_TagCondition-key"></a>
The tag key in the tag condition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_TagCondition-value"></a>
The tag value in the tag condition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_amazon-q-connect_TagCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TagCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TagCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TagCondition) 

# TagFilter
<a name="API_amazon-q-connect_TagFilter"></a>

An object that can be used to specify Tag conditions.

## Contents
<a name="API_amazon-q-connect_TagFilter_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** andConditions **   <a name="connect-Type-amazon-q-connect_TagFilter-andConditions"></a>
A list of conditions which would be applied together with an `AND` condition.  
Type: Array of [TagCondition](API_amazon-q-connect_TagCondition.md) objects  
Required: No

 ** orConditions **   <a name="connect-Type-amazon-q-connect_TagFilter-orConditions"></a>
A list of conditions which would be applied together with an `OR` condition.  
Type: Array of [OrCondition](API_amazon-q-connect_OrCondition.md) objects  
Required: No

 ** tagCondition **   <a name="connect-Type-amazon-q-connect_TagFilter-tagCondition"></a>
A leaf node condition which can be used to specify a tag condition.  
Type: [TagCondition](API_amazon-q-connect_TagCondition.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_TagFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TagFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TagFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TagFilter) 

# TextAIPromptInferenceConfiguration
<a name="API_amazon-q-connect_TextAIPromptInferenceConfiguration"></a>

Inference configuration for text-based AI Prompts.

## Contents
<a name="API_amazon-q-connect_TextAIPromptInferenceConfiguration_Contents"></a>

 ** maxTokensToSample **   <a name="connect-Type-amazon-q-connect_TextAIPromptInferenceConfiguration-maxTokensToSample"></a>
The maximum number of tokens to generate in the response.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 4096.  
Required: No

 ** temperature **   <a name="connect-Type-amazon-q-connect_TextAIPromptInferenceConfiguration-temperature"></a>
The temperature setting for controlling randomness in the generated response.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** topK **   <a name="connect-Type-amazon-q-connect_TextAIPromptInferenceConfiguration-topK"></a>
The top-K sampling parameter for token selection.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 200.  
Required: No

 ** topP **   <a name="connect-Type-amazon-q-connect_TextAIPromptInferenceConfiguration-topP"></a>
The top-P sampling parameter for nucleus sampling.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_TextAIPromptInferenceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TextAIPromptInferenceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TextAIPromptInferenceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TextAIPromptInferenceConfiguration) 

# TextData
<a name="API_amazon-q-connect_TextData"></a>

Details about the source content text data.

## Contents
<a name="API_amazon-q-connect_TextData_Contents"></a>

 ** excerpt **   <a name="connect-Type-amazon-q-connect_TextData-excerpt"></a>
The text of the document.  
Type: [DocumentText](API_amazon-q-connect_DocumentText.md) object  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_TextData-title"></a>
The text of the document.  
Type: [DocumentText](API_amazon-q-connect_DocumentText.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_TextData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TextData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TextData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TextData) 

# TextFullAIPromptEditTemplateConfiguration
<a name="API_amazon-q-connect_TextFullAIPromptEditTemplateConfiguration"></a>

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

## Contents
<a name="API_amazon-q-connect_TextFullAIPromptEditTemplateConfiguration_Contents"></a>

 ** text **   <a name="connect-Type-amazon-q-connect_TextFullAIPromptEditTemplateConfiguration-text"></a>
The YAML text for the AI Prompt template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000000.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_TextFullAIPromptEditTemplateConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TextFullAIPromptEditTemplateConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TextFullAIPromptEditTemplateConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TextFullAIPromptEditTemplateConfiguration) 

# TextMessage
<a name="API_amazon-q-connect_TextMessage"></a>

The message data in text type.

## Contents
<a name="API_amazon-q-connect_TextMessage_Contents"></a>

 ** aiGuardrailAssessment **   <a name="connect-Type-amazon-q-connect_TextMessage-aiGuardrailAssessment"></a>
The AI Guardrail assessment for the text message.  
Type: [AIGuardrailAssessment](API_amazon-q-connect_AIGuardrailAssessment.md) object  
Required: No

 ** citations **   <a name="connect-Type-amazon-q-connect_TextMessage-citations"></a>
The citations associated with the text message.  
Type: Array of [Citation](API_amazon-q-connect_Citation.md) objects  
Required: No

 ** value **   <a name="connect-Type-amazon-q-connect_TextMessage-value"></a>
The value of the message data in text type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_amazon-q-connect_TextMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TextMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TextMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TextMessage) 

# ToolConfiguration
<a name="API_amazon-q-connect_ToolConfiguration"></a>

Configuration settings for a tool used by AI Agents.

## Contents
<a name="API_amazon-q-connect_ToolConfiguration_Contents"></a>

 ** toolName **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-toolName"></a>
The name of the tool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** toolType **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-toolType"></a>
The type of the tool.  
Type: String  
Valid Values: `MODEL_CONTEXT_PROTOCOL | RETURN_TO_CONTROL | CONSTANT`   
Required: Yes

 ** annotations **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-annotations"></a>
Annotations for the tool configuration.  
Type: [Annotation](API_amazon-q-connect_Annotation.md) object  
Required: No

 ** description **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-description"></a>
The description of the tool configuration.  
Type: String  
Required: No

 ** inputSchema **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-inputSchema"></a>
The input schema for the tool configuration.  
Type: JSON value  
Required: No

 ** instruction **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-instruction"></a>
Instructions for using the tool.  
Type: [ToolInstruction](API_amazon-q-connect_ToolInstruction.md) object  
Required: No

 ** outputFilters **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-outputFilters"></a>
Output filters applies to the tool result.  
Type: Array of [ToolOutputFilter](API_amazon-q-connect_ToolOutputFilter.md) objects  
Required: No

 ** outputSchema **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-outputSchema"></a>
The output schema for the tool configuration.  
Type: JSON value  
Required: No

 ** overrideInputValues **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-overrideInputValues"></a>
Override input values for the tool configuration.  
Type: Array of [ToolOverrideInputValue](API_amazon-q-connect_ToolOverrideInputValue.md) objects  
Required: No

 ** title **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-title"></a>
The title of the tool configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** toolId **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-toolId"></a>
The identifier of the tool, for example toolName from Model Context Provider server.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** userInteractionConfiguration **   <a name="connect-Type-amazon-q-connect_ToolConfiguration-userInteractionConfiguration"></a>
Configuration for user interaction with the tool.  
Type: [UserInteractionConfiguration](API_amazon-q-connect_UserInteractionConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolConfiguration) 

# ToolInstruction
<a name="API_amazon-q-connect_ToolInstruction"></a>

Instructions for using a tool.

## Contents
<a name="API_amazon-q-connect_ToolInstruction_Contents"></a>

 ** examples **   <a name="connect-Type-amazon-q-connect_ToolInstruction-examples"></a>
Examples for using the tool.  
Type: Array of strings  
Required: No

 ** instruction **   <a name="connect-Type-amazon-q-connect_ToolInstruction-instruction"></a>
The instruction text for the tool.  
Type: String  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolInstruction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolInstruction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolInstruction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolInstruction) 

# ToolOutputConfiguration
<a name="API_amazon-q-connect_ToolOutputConfiguration"></a>

Configuration for tool output handling.

## Contents
<a name="API_amazon-q-connect_ToolOutputConfiguration_Contents"></a>

 ** outputVariableNameOverride **   <a name="connect-Type-amazon-q-connect_ToolOutputConfiguration-outputVariableNameOverride"></a>
Override the tool output results to different variable name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** sessionDataNamespace **   <a name="connect-Type-amazon-q-connect_ToolOutputConfiguration-sessionDataNamespace"></a>
The session data namespace for tool output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolOutputConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolOutputConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolOutputConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolOutputConfiguration) 

# ToolOutputFilter
<a name="API_amazon-q-connect_ToolOutputFilter"></a>

Filter configuration for tool output.

## Contents
<a name="API_amazon-q-connect_ToolOutputFilter_Contents"></a>

 ** jsonPath **   <a name="connect-Type-amazon-q-connect_ToolOutputFilter-jsonPath"></a>
The JSON path for filtering tool output.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** outputConfiguration **   <a name="connect-Type-amazon-q-connect_ToolOutputFilter-outputConfiguration"></a>
The output configuration for the filter.  
Type: [ToolOutputConfiguration](API_amazon-q-connect_ToolOutputConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolOutputFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolOutputFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolOutputFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolOutputFilter) 

# ToolOverrideConstantInputValue
<a name="API_amazon-q-connect_ToolOverrideConstantInputValue"></a>

A constant input value for tool override.

## Contents
<a name="API_amazon-q-connect_ToolOverrideConstantInputValue_Contents"></a>

 ** type **   <a name="connect-Type-amazon-q-connect_ToolOverrideConstantInputValue-type"></a>
Override tool input value with constant values  
Type: String  
Valid Values: `STRING | NUMBER | JSON_STRING`   
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_ToolOverrideConstantInputValue-value"></a>
The constant input override value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_ToolOverrideConstantInputValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolOverrideConstantInputValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolOverrideConstantInputValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolOverrideConstantInputValue) 

# ToolOverrideInputValue
<a name="API_amazon-q-connect_ToolOverrideInputValue"></a>

An input value override for tools.

## Contents
<a name="API_amazon-q-connect_ToolOverrideInputValue_Contents"></a>

 ** jsonPath **   <a name="connect-Type-amazon-q-connect_ToolOverrideInputValue-jsonPath"></a>
The JSON path for the input value override.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** value **   <a name="connect-Type-amazon-q-connect_ToolOverrideInputValue-value"></a>
The override input value.  
Type: [ToolOverrideInputValueConfiguration](API_amazon-q-connect_ToolOverrideInputValueConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_amazon-q-connect_ToolOverrideInputValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolOverrideInputValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolOverrideInputValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolOverrideInputValue) 

# ToolOverrideInputValueConfiguration
<a name="API_amazon-q-connect_ToolOverrideInputValueConfiguration"></a>

Configuration for overriding tool input values.

## Contents
<a name="API_amazon-q-connect_ToolOverrideInputValueConfiguration_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** constant **   <a name="connect-Type-amazon-q-connect_ToolOverrideInputValueConfiguration-constant"></a>
Constant input value configuration for tool override.  
Type: [ToolOverrideConstantInputValue](API_amazon-q-connect_ToolOverrideConstantInputValue.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolOverrideInputValueConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolOverrideInputValueConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolOverrideInputValueConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolOverrideInputValueConfiguration) 

# ToolUseResultData
<a name="API_amazon-q-connect_ToolUseResultData"></a>

Data about the result of tool usage.

## Contents
<a name="API_amazon-q-connect_ToolUseResultData_Contents"></a>

 ** toolName **   <a name="connect-Type-amazon-q-connect_ToolUseResultData-toolName"></a>
The name of the tool that was used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** toolResult **   <a name="connect-Type-amazon-q-connect_ToolUseResultData-toolResult"></a>
The result of the tool usage.  
Type: JSON value  
Required: Yes

 ** toolUseId **   <a name="connect-Type-amazon-q-connect_ToolUseResultData-toolUseId"></a>
The identifier of the tool use instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** inputSchema **   <a name="connect-Type-amazon-q-connect_ToolUseResultData-inputSchema"></a>
The input schema for the tool use result.  
Type: JSON value  
Required: No

## See Also
<a name="API_amazon-q-connect_ToolUseResultData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ToolUseResultData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ToolUseResultData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ToolUseResultData) 

# UrlConfiguration
<a name="API_amazon-q-connect_UrlConfiguration"></a>

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

## Contents
<a name="API_amazon-q-connect_UrlConfiguration_Contents"></a>

 ** seedUrls **   <a name="connect-Type-amazon-q-connect_UrlConfiguration-seedUrls"></a>
List of URLs for crawling.  
Type: Array of [SeedUrl](API_amazon-q-connect_SeedUrl.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

## See Also
<a name="API_amazon-q-connect_UrlConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UrlConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UrlConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UrlConfiguration) 

# UserInteractionConfiguration
<a name="API_amazon-q-connect_UserInteractionConfiguration"></a>

Configuration for user interaction settings.

## Contents
<a name="API_amazon-q-connect_UserInteractionConfiguration_Contents"></a>

 ** isUserConfirmationRequired **   <a name="connect-Type-amazon-q-connect_UserInteractionConfiguration-isUserConfirmationRequired"></a>
Indicates whether user confirmation is required for the interaction.  
Type: Boolean  
Required: No

## See Also
<a name="API_amazon-q-connect_UserInteractionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UserInteractionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UserInteractionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UserInteractionConfiguration) 

# VectorIngestionConfiguration
<a name="API_amazon-q-connect_VectorIngestionConfiguration"></a>

Contains details about how to ingest the documents in a data source.

## Contents
<a name="API_amazon-q-connect_VectorIngestionConfiguration_Contents"></a>

 ** chunkingConfiguration **   <a name="connect-Type-amazon-q-connect_VectorIngestionConfiguration-chunkingConfiguration"></a>
Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.  
Type: [ChunkingConfiguration](API_amazon-q-connect_ChunkingConfiguration.md) object  
Required: No

 ** parsingConfiguration **   <a name="connect-Type-amazon-q-connect_VectorIngestionConfiguration-parsingConfiguration"></a>
A custom parser for data source documents.  
Type: [ParsingConfiguration](API_amazon-q-connect_ParsingConfiguration.md) object  
Required: No

## See Also
<a name="API_amazon-q-connect_VectorIngestionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/VectorIngestionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/VectorIngestionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/VectorIngestionConfiguration) 

# WebCrawlerConfiguration
<a name="API_amazon-q-connect_WebCrawlerConfiguration"></a>

The configuration details for the web data source.

## Contents
<a name="API_amazon-q-connect_WebCrawlerConfiguration_Contents"></a>

 ** urlConfiguration **   <a name="connect-Type-amazon-q-connect_WebCrawlerConfiguration-urlConfiguration"></a>
The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.  
Type: [UrlConfiguration](API_amazon-q-connect_UrlConfiguration.md) object  
Required: Yes

 ** crawlerLimits **   <a name="connect-Type-amazon-q-connect_WebCrawlerConfiguration-crawlerLimits"></a>
The configuration of crawl limits for the web URLs.  
Type: [WebCrawlerLimits](API_amazon-q-connect_WebCrawlerLimits.md) object  
Required: No

 ** exclusionFilters **   <a name="connect-Type-amazon-q-connect_WebCrawlerConfiguration-exclusionFilters"></a>
A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** inclusionFilters **   <a name="connect-Type-amazon-q-connect_WebCrawlerConfiguration-inclusionFilters"></a>
A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** scope **   <a name="connect-Type-amazon-q-connect_WebCrawlerConfiguration-scope"></a>
The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL `https://docs.aws.amazon.com/bedrock/latest/userguide/` and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain `aws.amazon.com` can also include sub domain `docs.aws.amazon.com`.  
Type: String  
Valid Values: `HOST_ONLY | SUBDOMAINS`   
Required: No

## See Also
<a name="API_amazon-q-connect_WebCrawlerConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/WebCrawlerConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/WebCrawlerConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/WebCrawlerConfiguration) 

# WebCrawlerLimits
<a name="API_amazon-q-connect_WebCrawlerLimits"></a>

The configuration of crawl limits for the web URLs.

## Contents
<a name="API_amazon-q-connect_WebCrawlerLimits_Contents"></a>

 ** rateLimit **   <a name="connect-Type-amazon-q-connect_WebCrawlerLimits-rateLimit"></a>
Rate of web URLs retrieved per minute.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 300.  
Required: No

## See Also
<a name="API_amazon-q-connect_WebCrawlerLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/WebCrawlerLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/WebCrawlerLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/WebCrawlerLimits) 

# WhatsAppMessageTemplateContent
<a name="API_amazon-q-connect_WhatsAppMessageTemplateContent"></a>

The content of the message template that applies to the WHATSAPP channel subtype.

## Contents
<a name="API_amazon-q-connect_WhatsAppMessageTemplateContent_Contents"></a>

 ** data **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateContent-data"></a>
The data.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6000.  
Required: No

## See Also
<a name="API_amazon-q-connect_WhatsAppMessageTemplateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/WhatsAppMessageTemplateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/WhatsAppMessageTemplateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/WhatsAppMessageTemplateContent) 

# WhatsAppMessageTemplateSourceConfiguration
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration"></a>

Configuration information about the external data source.

## Contents
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration_Contents"></a>

 ** businessAccountId **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration-businessAccountId"></a>
The ID of the End User Messaging WhatsApp Business Account to associate with this template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*(^waba-[0-9a-zA-Z]+$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*`   
Required: Yes

 ** templateId **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration-templateId"></a>
The WhatsApp template ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9]+`   
Required: Yes

 ** components **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration-components"></a>
The list of component mapping from WhatsApp template parameters to Message Template attributes.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Required: No

## See Also
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfiguration) 

# WhatsAppMessageTemplateSourceConfigurationSummary
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary"></a>

Configuration information about the external data source.

## Contents
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary_Contents"></a>

 ** businessAccountId **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-businessAccountId"></a>
The ID of the End User Messaging WhatsApp Business Account to associate with this template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*(^waba-[0-9a-zA-Z]+$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*`   
Required: Yes

 ** templateId **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-templateId"></a>
The ID of WhatsApp template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9]+`   
Required: Yes

 ** components **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-components"></a>
The list of component mapping from WhatsApp template parameters to Message Template attributes.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Required: No

 ** language **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-language"></a>
The language of the WhatsApp template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5.  
Required: No

 ** name **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-name"></a>
The name of the WhatsApp template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** status **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-status"></a>
The status of the message template.  
Type: String  
Valid Values: `VALID | INVALID | REJECTED`   
Required: No

 ** statusReason **   <a name="connect-Type-amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary-statusReason"></a>
The status reason of the message template.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_amazon-q-connect_WhatsAppMessageTemplateSourceConfigurationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfigurationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfigurationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfigurationSummary)