Module Awso_qconnect_lwtSource

include module type of struct include Awso_qconnect.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule AIAgentAssociationConfigurationType = Awso_qconnect.Values.AIAgentAssociationConfigurationType

A leaf node condition which can be used to specify a tag condition.

A list of conditions which would be applied together with an OR condition.

An object that can be used to specify Tag conditions.

Sourcemodule KnowledgeBaseAssociationConfigurationData = Awso_qconnect.Values.KnowledgeBaseAssociationConfigurationData

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

Sourcemodule AssociationConfigurationData = Awso_qconnect.Values.AssociationConfigurationData

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

Sourcemodule AssociationConfiguration = Awso_qconnect.Values.AssociationConfiguration

The configuration for an Amazon Q in Connect Assistant Association.

Sourcemodule AssociationConfigurationList = Awso_qconnect.Values.AssociationConfigurationList
Sourcemodule SelfServiceAIAgentConfiguration = Awso_qconnect.Values.SelfServiceAIAgentConfiguration

The configuration for AI Agents of type SELF_SERVICE.

Sourcemodule UserInteractionConfiguration = Awso_qconnect.Values.UserInteractionConfiguration

Configuration for user interaction settings.

Sourcemodule ToolOverrideInputValueType = Awso_qconnect.Values.ToolOverrideInputValueType
Sourcemodule ToolOverrideConstantInputValue = Awso_qconnect.Values.ToolOverrideConstantInputValue

A constant input value for tool override.

Sourcemodule ToolOverrideInputValueConfiguration = Awso_qconnect.Values.ToolOverrideInputValueConfiguration

Configuration for overriding tool input values.

An input value override for tools.

Sourcemodule ToolOverrideInputValueList = Awso_qconnect.Values.ToolOverrideInputValueList

Configuration for tool output handling.

Filter configuration for tool output.

Instructions for using a tool.

An annotation that provides additional context or metadata.

Configuration settings for a tool used by AI Agents.

Sourcemodule OrchestrationAIAgentConfiguration = Awso_qconnect.Values.OrchestrationAIAgentConfiguration

The configuration for AI Agents of type ORCHESTRATION.

Sourcemodule NoteTakingAIAgentConfiguration = Awso_qconnect.Values.NoteTakingAIAgentConfiguration

The configuration for AI Agents of type NOTE_TAKING.

Sourcemodule ManualSearchAIAgentConfiguration = Awso_qconnect.Values.ManualSearchAIAgentConfiguration

The configuration for the MANUAL_SEARCH AI Agent type.

Sourcemodule EmailResponseAIAgentConfiguration = Awso_qconnect.Values.EmailResponseAIAgentConfiguration

Configuration settings for the EMAIL_RESPONSE AI agent including prompts, locale, and knowledge base associations.

Sourcemodule EmailOverviewAIAgentConfiguration = Awso_qconnect.Values.EmailOverviewAIAgentConfiguration

Configuration settings for the EMAIL_OVERVIEW AI agent including prompt ID and locale settings.

Sourcemodule EmailGenerativeAnswerAIAgentConfiguration = Awso_qconnect.Values.EmailGenerativeAnswerAIAgentConfiguration

Configuration settings for the EMAIL_GENERATIVE_ANSWER AI agent including prompts, locale, and knowledge base associations.

Sourcemodule CaseSummarizationAIAgentConfiguration = Awso_qconnect.Values.CaseSummarizationAIAgentConfiguration

The configuration for AI Agents of type CASE_SUMMARIZATION.

Sourcemodule AnswerRecommendationAIAgentConfiguration = Awso_qconnect.Values.AnswerRecommendationAIAgentConfiguration

The configuration for the ANSWER_RECOMMENDATION AI Agent type.

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

Sourcemodule AIAgentConfigurationData = Awso_qconnect.Values.AIAgentConfigurationData

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.

The data for the AI Agent.

The summary of the AI Agent.

The summary of the AI Agent version.

Sourcemodule AIAgentVersionSummariesList = Awso_qconnect.Values.AIAgentVersionSummariesList

The assessment information from the AI Guardrail.

Sourcemodule AIGuardrailBlockedMessaging = Awso_qconnect.Values.AIGuardrailBlockedMessaging

Messaging for when violations are detected in text

Sourcemodule GuardrailContentFilterType = Awso_qconnect.Values.GuardrailContentFilterType
Sourcemodule GuardrailContentFilterConfig = Awso_qconnect.Values.GuardrailContentFilterConfig

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.

Sourcemodule GuardrailContentFiltersConfig = Awso_qconnect.Values.GuardrailContentFiltersConfig
Sourcemodule AIGuardrailContentPolicyConfig = Awso_qconnect.Values.AIGuardrailContentPolicyConfig

Contains details about how to handle harmful content.

Sourcemodule GuardrailContextualGroundingFilterType = Awso_qconnect.Values.GuardrailContextualGroundingFilterType
Sourcemodule GuardrailContextualGroundingFilterThreshold = Awso_qconnect.Values.GuardrailContextualGroundingFilterThreshold

The threshold for this filter.

Sourcemodule GuardrailContextualGroundingFilterConfig = Awso_qconnect.Values.GuardrailContextualGroundingFilterConfig

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

Sourcemodule GuardrailContextualGroundingFiltersConfig = Awso_qconnect.Values.GuardrailContextualGroundingFiltersConfig
Sourcemodule AIGuardrailContextualGroundingPolicyConfig = Awso_qconnect.Values.AIGuardrailContextualGroundingPolicyConfig

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

The custom word text.

A word to configure for the AI Guardrail.

Sourcemodule GuardrailManagedWordsType = Awso_qconnect.Values.GuardrailManagedWordsType
Sourcemodule GuardrailManagedWordsConfig = Awso_qconnect.Values.GuardrailManagedWordsConfig

The managed word list to configure for the AI Guardrail.

Sourcemodule GuardrailManagedWordListsConfig = Awso_qconnect.Values.GuardrailManagedWordListsConfig
Sourcemodule AIGuardrailWordPolicyConfig = Awso_qconnect.Values.AIGuardrailWordPolicyConfig

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

Name of topic in topic policy

Text example in topic policy

Sourcemodule GuardrailTopicDefinition = Awso_qconnect.Values.GuardrailTopicDefinition

Definition of topic in topic policy

Details about topics for the AI Guardrail to identify and deny.

Sourcemodule AIGuardrailTopicPolicyConfig = Awso_qconnect.Values.AIGuardrailTopicPolicyConfig

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

Sourcemodule GuardrailSensitiveInformationAction = Awso_qconnect.Values.GuardrailSensitiveInformationAction

The regex pattern.

The regex name.

Sourcemodule GuardrailRegexDescription = Awso_qconnect.Values.GuardrailRegexDescription

The regex description.

The regular expression to configure for the AI Guardrail.

Sourcemodule GuardrailPiiEntityConfig = Awso_qconnect.Values.GuardrailPiiEntityConfig

The PII entity to configure for the AI Guardrail.

Sourcemodule GuardrailPiiEntitiesConfig = Awso_qconnect.Values.GuardrailPiiEntitiesConfig
Sourcemodule AIGuardrailSensitiveInformationPolicyConfig = Awso_qconnect.Values.AIGuardrailSensitiveInformationPolicyConfig

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

Description of the guardrail or its version

The data for the AI Guardrail

The summary of the AI Guardrail.

Sourcemodule AIGuardrailSummariesList = Awso_qconnect.Values.AIGuardrailSummariesList
Sourcemodule AIGuardrailVersionSummary = Awso_qconnect.Values.AIGuardrailVersionSummary

The summary of the AI Guardrail version.

Sourcemodule AIGuardrailVersionSummariesList = Awso_qconnect.Values.AIGuardrailVersionSummariesList
Sourcemodule TextFullAIPromptEditTemplateConfiguration = Awso_qconnect.Values.TextFullAIPromptEditTemplateConfiguration

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

Sourcemodule AIPromptTemplateConfiguration = Awso_qconnect.Values.AIPromptTemplateConfiguration

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

Sourcemodule AIPromptInferenceConfiguration = Awso_qconnect.Values.AIPromptInferenceConfiguration

The configuration for inference parameters when using AI Prompts.

The data for the AI Prompt

The summary of the AI Prompt.

The summary of the AI Prompt version.

Sourcemodule AIPromptVersionSummariesList = Awso_qconnect.Values.AIPromptVersionSummariesList

You do not have sufficient access to perform this action.

Sourcemodule UuidOrArnOrEitherWithQualifier = Awso_qconnect.Values.UuidOrArnOrEitherWithQualifier
Sourcemodule ActivateMessageTemplateRequest = Awso_qconnect.Values.ActivateMessageTemplateRequest

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

The input fails to satisfy the constraints specified by a service.

The throttling limit has been exceeded.

Sourcemodule ResourceNotFoundException = Awso_qconnect.Values.ResourceNotFoundException

The specified resource does not exist.

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

Sourcemodule ActivateMessageTemplateResponse = Awso_qconnect.Values.ActivateMessageTemplateResponse

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

Sourcemodule MessageTemplateAttributeValue = Awso_qconnect.Values.MessageTemplateAttributeValue

Information about an agent.

Sourcemodule AmazonConnectGuideAssociationData = Awso_qconnect.Values.AmazonConnectGuideAssociationData

Content association data for a step-by-step guide.

Sourcemodule AppIntegrationsConfiguration = Awso_qconnect.Values.AppIntegrationsConfiguration

Configuration information for Amazon AppIntegrations to automatically ingest content.

Sourcemodule KnowledgeBaseAssociationData = Awso_qconnect.Values.KnowledgeBaseAssociationData

Association information about the knowledge base.

Sourcemodule ExternalBedrockKnowledgeBaseConfig = Awso_qconnect.Values.ExternalBedrockKnowledgeBaseConfig

Configuration for an external Bedrock knowledge base.

Sourcemodule AssistantAssociationOutputData = Awso_qconnect.Values.AssistantAssociationOutputData

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

Sourcemodule AssistantAssociationData = Awso_qconnect.Values.AssistantAssociationData

Information about the assistant association.

Sourcemodule AssistantAssociationIdList = Awso_qconnect.Values.AssistantAssociationIdList
Sourcemodule AssistantAssociationInputData = Awso_qconnect.Values.AssistantAssociationInputData

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

Sourcemodule AssistantAssociationSummary = Awso_qconnect.Values.AssistantAssociationSummary

Summary information about the assistant association.

Sourcemodule AssistantAssociationSummaryList = Awso_qconnect.Values.AssistantAssociationSummaryList
Sourcemodule AssistantCapabilityConfiguration = Awso_qconnect.Values.AssistantCapabilityConfiguration

The capability configuration for an Amazon Q in Connect assistant.

Sourcemodule ServerSideEncryptionConfiguration = Awso_qconnect.Values.ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

Sourcemodule OrchestratorConfigurationEntry = Awso_qconnect.Values.OrchestratorConfigurationEntry

An entry in the orchestrator configuration list.

Sourcemodule OrchestratorConfigurationList = Awso_qconnect.Values.OrchestratorConfigurationList
Sourcemodule AssistantIntegrationConfiguration = Awso_qconnect.Values.AssistantIntegrationConfiguration

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

The assistant data.

Summary information about the assistant.

Instructions for interpreting the contents of a document.

Sourcemodule BedrockModelArnForParsing = Awso_qconnect.Values.BedrockModelArnForParsing
Sourcemodule BedrockFoundationModelConfigurationForParsing = Awso_qconnect.Values.BedrockFoundationModelConfigurationForParsing

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

Sourcemodule CaseSummarizationChunkDataDetails = Awso_qconnect.Values.CaseSummarizationChunkDataDetails

Details about case summarization chunk data.

Sourcemodule CaseSummarizationInputData = Awso_qconnect.Values.CaseSummarizationInputData

Input data for case summarization.

Sourcemodule SemanticChunkingConfigurationMaxTokensInteger = Awso_qconnect.Values.SemanticChunkingConfigurationMaxTokensInteger
Sourcemodule SemanticChunkingConfigurationBufferSizeInteger = Awso_qconnect.Values.SemanticChunkingConfigurationBufferSizeInteger
Sourcemodule SemanticChunkingConfigurationBreakpointPercentileThresholdInteger = Awso_qconnect.Values.SemanticChunkingConfigurationBreakpointPercentileThresholdInteger
Sourcemodule SemanticChunkingConfiguration = Awso_qconnect.Values.SemanticChunkingConfiguration

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.

Sourcemodule HierarchicalChunkingLevelConfigurationMaxTokensInteger = Awso_qconnect.Values.HierarchicalChunkingLevelConfigurationMaxTokensInteger
Sourcemodule HierarchicalChunkingLevelConfiguration = Awso_qconnect.Values.HierarchicalChunkingLevelConfiguration

Token settings for each layer.

Sourcemodule HierarchicalChunkingLevelConfigurations = Awso_qconnect.Values.HierarchicalChunkingLevelConfigurations
Sourcemodule HierarchicalChunkingConfigurationOverlapTokensInteger = Awso_qconnect.Values.HierarchicalChunkingConfigurationOverlapTokensInteger
Sourcemodule HierarchicalChunkingConfiguration = Awso_qconnect.Values.HierarchicalChunkingConfiguration

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.

Sourcemodule FixedSizeChunkingConfigurationOverlapPercentageInteger = Awso_qconnect.Values.FixedSizeChunkingConfigurationOverlapPercentageInteger
Sourcemodule FixedSizeChunkingConfigurationMaxTokensInteger = Awso_qconnect.Values.FixedSizeChunkingConfigurationMaxTokensInteger
Sourcemodule FixedSizeChunkingConfiguration = Awso_qconnect.Values.FixedSizeChunkingConfiguration

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

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.

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

A citation that references source content.

The configuration information of the Amazon Connect data source.

The configuration information of the external data source.

Sourcemodule ContentAssociationContents = Awso_qconnect.Values.ContentAssociationContents

The contents of a content association.

Information about the content association.

Sourcemodule ContentAssociationSummary = Awso_qconnect.Values.ContentAssociationSummary

Summary information about a content association.

Sourcemodule ContentAssociationSummaryList = Awso_qconnect.Values.ContentAssociationSummaryList
Sourcemodule SyntheticTimestamp_epoch_seconds = Awso_qconnect.Values.SyntheticTimestamp_epoch_seconds

Information about the content.

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

The text of the document.

Details about the source content text data.

Details about the source content ranking data.

Details about the content data.

Sourcemodule GenerativeContentFeedbackData = Awso_qconnect.Values.GenerativeContentFeedbackData

The feedback information for a generative target type.

Information about the feedback.

Reference information about the content.

Summary information about the content.

Sourcemodule SelfServiceConversationHistory = Awso_qconnect.Values.SelfServiceConversationHistory

The conversation history data to included in conversation context data before the Amazon Q in Connect session.

Sourcemodule SelfServiceConversationHistoryList = Awso_qconnect.Values.SelfServiceConversationHistoryList

The conversation context to include in SendMessage.

Sourcemodule ConversationStatusReason = Awso_qconnect.Values.ConversationStatusReason

The conversation state associated to a message.

Creates an Amazon Q in Connect AI Agent.

You do not have permission to perform this action.

Sourcemodule ServiceQuotaExceededException = Awso_qconnect.Values.ServiceQuotaExceededException

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

Creates an Amazon Q in Connect AI Agent.

Sourcemodule CreateAIAgentVersionRequest = Awso_qconnect.Values.CreateAIAgentVersionRequest

Creates and Amazon Q in Connect AI Agent version.

Sourcemodule CreateAIAgentVersionResponse = Awso_qconnect.Values.CreateAIAgentVersionResponse

Creates and Amazon Q in Connect AI Agent version.

Sourcemodule CreateAIGuardrailRequest = Awso_qconnect.Values.CreateAIGuardrailRequest

Creates an Amazon Q in Connect AI Guardrail.

Sourcemodule CreateAIGuardrailResponse = Awso_qconnect.Values.CreateAIGuardrailResponse

Creates an Amazon Q in Connect AI Guardrail.

Sourcemodule CreateAIGuardrailVersionRequest = Awso_qconnect.Values.CreateAIGuardrailVersionRequest

Creates an Amazon Q in Connect AI Guardrail version.

Sourcemodule CreateAIGuardrailVersionResponse = Awso_qconnect.Values.CreateAIGuardrailVersionResponse

Creates an Amazon Q in Connect AI Guardrail version.

Creates an Amazon Q in Connect AI Prompt.

Creates an Amazon Q in Connect AI Prompt.

Sourcemodule CreateAIPromptVersionRequest = Awso_qconnect.Values.CreateAIPromptVersionRequest

Creates an Amazon Q in Connect AI Prompt version.

Sourcemodule CreateAIPromptVersionResponse = Awso_qconnect.Values.CreateAIPromptVersionResponse

Creates an Amazon Q in Connect AI Prompt version.

Sourcemodule CreateAssistantAssociationRequest = Awso_qconnect.Values.CreateAssistantAssociationRequest

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Sourcemodule CreateAssistantAssociationResponse = Awso_qconnect.Values.CreateAssistantAssociationResponse

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Creates an Amazon Q in Connect assistant.

Creates an Amazon Q in Connect assistant.

Sourcemodule CreateContentAssociationRequest = Awso_qconnect.Values.CreateContentAssociationRequest

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. Note the following limitations: You can create only one content association for each content resource in a knowledge base. You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Sourcemodule CreateContentAssociationResponse = Awso_qconnect.Values.CreateContentAssociationResponse

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. Note the following limitations: You can create only one content association for each content resource in a knowledge base. You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

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.

Sourcemodule VectorIngestionConfiguration = Awso_qconnect.Values.VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

Sourcemodule WebCrawlerLimitsRateLimitInteger = Awso_qconnect.Values.WebCrawlerLimitsRateLimitInteger

The configuration of crawl limits for the web URLs.

A URL for crawling.

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

The configuration details for the web data source.

Sourcemodule ManagedSourceConfiguration = Awso_qconnect.Values.ManagedSourceConfiguration

Source configuration for managed resources.

Configuration information about the external data source.

Information about how to render the content.

Sourcemodule CreateKnowledgeBaseRequest = Awso_qconnect.Values.CreateKnowledgeBaseRequest

Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a create different one. Call CreateKnowledgeBase.

Information about the knowledge base.

Sourcemodule CreateKnowledgeBaseResponse = Awso_qconnect.Values.CreateKnowledgeBaseResponse

Creates a knowledge base. When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error. For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreate the DataIntegration or a create different one. Call CreateKnowledgeBase.

Sourcemodule CreateMessageTemplateAttachmentRequest = Awso_qconnect.Values.CreateMessageTemplateAttachmentRequest

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

Sourcemodule SyntheticTimestamp_date_time = Awso_qconnect.Values.SyntheticTimestamp_date_time
Sourcemodule MessageTemplateAttachment = Awso_qconnect.Values.MessageTemplateAttachment

Information about the message template attachment.

Sourcemodule CreateMessageTemplateAttachmentResponse = Awso_qconnect.Values.CreateMessageTemplateAttachmentResponse

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

Sourcemodule WhatsAppMessageTemplateId = Awso_qconnect.Values.WhatsAppMessageTemplateId
Sourcemodule WhatsAppMessageTemplateComponent = Awso_qconnect.Values.WhatsAppMessageTemplateComponent

The component mapping from WhatsApp template parameters to Message Template attributes.

Sourcemodule WhatsAppMessageTemplateComponents = Awso_qconnect.Values.WhatsAppMessageTemplateComponents
Sourcemodule WhatsAppBusinessAccountId = Awso_qconnect.Values.WhatsAppBusinessAccountId
Sourcemodule WhatsAppMessageTemplateSourceConfiguration = Awso_qconnect.Values.WhatsAppMessageTemplateSourceConfiguration

Configuration information about the external data source.

Sourcemodule MessageTemplateSourceConfiguration = Awso_qconnect.Values.MessageTemplateSourceConfiguration

The container of message template source configuration.

Sourcemodule WhatsAppMessageTemplateContentData = Awso_qconnect.Values.WhatsAppMessageTemplateContentData
Sourcemodule WhatsAppMessageTemplateContent = Awso_qconnect.Values.WhatsAppMessageTemplateContent

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

Sourcemodule MessageTemplateBodyContentProvider = Awso_qconnect.Values.MessageTemplateBodyContentProvider

The container of the message template body.

Sourcemodule SMSMessageTemplateContentBody = Awso_qconnect.Values.SMSMessageTemplateContentBody

The body to use in SMS messages.

Sourcemodule SMSMessageTemplateContent = Awso_qconnect.Values.SMSMessageTemplateContent

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

Sourcemodule PushFCMMessageTemplateContent = Awso_qconnect.Values.PushFCMMessageTemplateContent

The content of the push message template that applies to FCM (Firebase Cloud Messaging) notification service.

Sourcemodule PushBaiduMessageTemplateContent = Awso_qconnect.Values.PushBaiduMessageTemplateContent

The content of the push message template that applies to Baidu notification service.

Sourcemodule PushAPNSMessageTemplateContent = Awso_qconnect.Values.PushAPNSMessageTemplateContent

The content of the push message template that applies to APNS (Apple Push Notification service) notification service.

Sourcemodule PushADMMessageTemplateContent = Awso_qconnect.Values.PushADMMessageTemplateContent

The content of the push message template that applies to ADM (Amazon Device Messaging) notification service.

Sourcemodule PushMessageTemplateContent = Awso_qconnect.Values.PushMessageTemplateContent

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

Sourcemodule EmailMessageTemplateContentBody = Awso_qconnect.Values.EmailMessageTemplateContentBody

The body to use in email messages.

The email header to include in email messages.

Sourcemodule EmailMessageTemplateContent = Awso_qconnect.Values.EmailMessageTemplateContent

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

Sourcemodule MessageTemplateContentProvider = Awso_qconnect.Values.MessageTemplateContentProvider

The container of message template content.

Sourcemodule SystemEndpointAttributes = Awso_qconnect.Values.SystemEndpointAttributes

The system endpoint attributes that are used with the message template.

The system attributes that are used with the message template.

Sourcemodule MessageTemplateAttributeKey = Awso_qconnect.Values.MessageTemplateAttributeKey
Sourcemodule CustomerProfileAttributes = Awso_qconnect.Values.CustomerProfileAttributes

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

Sourcemodule MessageTemplateAttributes = Awso_qconnect.Values.MessageTemplateAttributes

The attributes that are used with the message template.

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

Sourcemodule CreateMessageTemplateRequest = Awso_qconnect.Values.CreateMessageTemplateRequest

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

Sourcemodule WhatsAppSourceConfigurationStatus = Awso_qconnect.Values.WhatsAppSourceConfigurationStatus
Sourcemodule WhatsAppMessageTemplateName = Awso_qconnect.Values.WhatsAppMessageTemplateName
Sourcemodule WhatsAppMessageTemplateLanguage = Awso_qconnect.Values.WhatsAppMessageTemplateLanguage
Sourcemodule WhatsAppMessageTemplateSourceConfigurationSummary = Awso_qconnect.Values.WhatsAppMessageTemplateSourceConfigurationSummary

Configuration information about the external data source.

Sourcemodule MessageTemplateSourceConfigurationSummary = Awso_qconnect.Values.MessageTemplateSourceConfigurationSummary

The container of message template source configuration summary.

Sourcemodule MessageTemplateContentSha256 = Awso_qconnect.Values.MessageTemplateContentSha256
Sourcemodule MessageTemplateAttributeType = Awso_qconnect.Values.MessageTemplateAttributeType
Sourcemodule MessageTemplateAttributeTypeList = Awso_qconnect.Values.MessageTemplateAttributeTypeList

The data of a message template.

Sourcemodule CreateMessageTemplateResponse = Awso_qconnect.Values.CreateMessageTemplateResponse

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

Sourcemodule CreateMessageTemplateVersionRequest = Awso_qconnect.Values.CreateMessageTemplateVersionRequest

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

Sourcemodule MessageTemplateAttachmentList = Awso_qconnect.Values.MessageTemplateAttachmentList
Sourcemodule ExtendedMessageTemplateData = Awso_qconnect.Values.ExtendedMessageTemplateData

The extended data of a message template.

Sourcemodule CreateMessageTemplateVersionResponse = Awso_qconnect.Values.CreateMessageTemplateVersionResponse

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

Sourcemodule QuickResponseDescription = Awso_qconnect.Values.QuickResponseDescription
Sourcemodule QuickResponseDataProvider = Awso_qconnect.Values.QuickResponseDataProvider

The container of quick response data.

Sourcemodule CreateQuickResponseRequest = Awso_qconnect.Values.CreateQuickResponseRequest

Creates an Amazon Q in Connect quick response.

Sourcemodule QuickResponseContentProvider = Awso_qconnect.Values.QuickResponseContentProvider

The container quick response content.

The content of the quick response stored in different media types.

Information about the quick response.

Sourcemodule CreateQuickResponseResponse = Awso_qconnect.Values.CreateQuickResponseResponse

Creates an Amazon Q in Connect quick response.

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Sourcemodule SessionIntegrationConfiguration = Awso_qconnect.Values.SessionIntegrationConfiguration

The configuration information for the session integration.

Information about the session.

Sourcemodule DependencyFailedException = Awso_qconnect.Values.DependencyFailedException

The request failed because it depends on another request that failed.

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Sourcemodule SuggestedMessageDataDetails = Awso_qconnect.Values.SuggestedMessageDataDetails

Details about suggested message data.

Sourcemodule SourceContentDataDetails = Awso_qconnect.Values.SourceContentDataDetails

Details about the source content data.

Details about notes data.

Details about notes chunk data.

Sourcemodule IntentDetectedDataDetails = Awso_qconnect.Values.IntentDetectedDataDetails

Details about the detected intent.

Sourcemodule SuggestedMessageReference = Awso_qconnect.Values.SuggestedMessageReference

Reference information for a suggested message.

Reference information about generative content.

Reference data.

Sourcemodule EmailResponseChunkDataDetails = Awso_qconnect.Values.EmailResponseChunkDataDetails

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

Sourcemodule EmailOverviewChunkDataDetails = Awso_qconnect.Values.EmailOverviewChunkDataDetails

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

Details about the data.

Summary of the data.

module DataSummaryList = Awso_qconnect.Values.DataSummaryList
module EmailGenerativeAnswerChunkDataDetails = Awso_qconnect.Values.EmailGenerativeAnswerChunkDataDetails

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

module GenerativeChunkDataDetails = Awso_qconnect.Values.GenerativeChunkDataDetails

Details about the generative chunk data.

module GenerativeDataDetails = Awso_qconnect.Values.GenerativeDataDetails

Details about generative data.

Sourcemodule DeactivateMessageTemplateRequest = Awso_qconnect.Values.DeactivateMessageTemplateRequest

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

Sourcemodule DeactivateMessageTemplateResponse = Awso_qconnect.Values.DeactivateMessageTemplateResponse

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

Deletes an Amazon Q in Connect AI Agent.

Deletes an Amazon Q in Connect AI Agent.

Sourcemodule DeleteAIAgentVersionRequest = Awso_qconnect.Values.DeleteAIAgentVersionRequest

Deletes an Amazon Q in Connect AI Agent Version.

Sourcemodule DeleteAIAgentVersionResponse = Awso_qconnect.Values.DeleteAIAgentVersionResponse

Deletes an Amazon Q in Connect AI Agent Version.

Sourcemodule DeleteAIGuardrailRequest = Awso_qconnect.Values.DeleteAIGuardrailRequest

Deletes an Amazon Q in Connect AI Guardrail.

Sourcemodule DeleteAIGuardrailResponse = Awso_qconnect.Values.DeleteAIGuardrailResponse

Deletes an Amazon Q in Connect AI Guardrail.

Sourcemodule DeleteAIGuardrailVersionRequest = Awso_qconnect.Values.DeleteAIGuardrailVersionRequest

Delete and Amazon Q in Connect AI Guardrail version.

Sourcemodule DeleteAIGuardrailVersionResponse = Awso_qconnect.Values.DeleteAIGuardrailVersionResponse

Delete and Amazon Q in Connect AI Guardrail version.

Deletes an Amazon Q in Connect AI Prompt.

Deletes an Amazon Q in Connect AI Prompt.

Sourcemodule DeleteAIPromptVersionRequest = Awso_qconnect.Values.DeleteAIPromptVersionRequest

Delete and Amazon Q in Connect AI Prompt version.

Sourcemodule DeleteAIPromptVersionResponse = Awso_qconnect.Values.DeleteAIPromptVersionResponse

Delete and Amazon Q in Connect AI Prompt version.

Sourcemodule DeleteAssistantAssociationRequest = Awso_qconnect.Values.DeleteAssistantAssociationRequest

Deletes an assistant association.

Sourcemodule DeleteAssistantAssociationResponse = Awso_qconnect.Values.DeleteAssistantAssociationResponse

Deletes an assistant association.

Deletes an assistant.

Deletes an assistant.

Sourcemodule DeleteContentAssociationRequest = Awso_qconnect.Values.DeleteContentAssociationRequest

Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Sourcemodule DeleteContentAssociationResponse = Awso_qconnect.Values.DeleteContentAssociationResponse

Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Deletes the content.

Deletes the content.

Deletes the quick response import job.

Deletes the quick response import job.

Sourcemodule DeleteKnowledgeBaseRequest = Awso_qconnect.Values.DeleteKnowledgeBaseRequest

Deletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Sourcemodule DeleteKnowledgeBaseResponse = Awso_qconnect.Values.DeleteKnowledgeBaseResponse

Deletes the knowledge base. When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Sourcemodule DeleteMessageTemplateAttachmentRequest = Awso_qconnect.Values.DeleteMessageTemplateAttachmentRequest

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

Sourcemodule DeleteMessageTemplateAttachmentResponse = Awso_qconnect.Values.DeleteMessageTemplateAttachmentResponse

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

Sourcemodule DeleteMessageTemplateRequest = Awso_qconnect.Values.DeleteMessageTemplateRequest

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

Sourcemodule DeleteMessageTemplateResponse = Awso_qconnect.Values.DeleteMessageTemplateResponse

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

Sourcemodule DeleteQuickResponseRequest = Awso_qconnect.Values.DeleteQuickResponseRequest

Deletes a quick response.

Sourcemodule DeleteQuickResponseResponse = Awso_qconnect.Values.DeleteQuickResponseResponse

Deletes a quick response.

The document.

Sourcemodule ExternalSourceConfiguration = Awso_qconnect.Values.ExternalSourceConfiguration

The configuration information of the external data source.

A search filter.

An attribute used for filtering.

Gets an Amazon Q in Connect AI Agent.

Gets an Amazon Q in Connect AI Agent.

Gets the Amazon Q in Connect AI Guardrail.

Gets the Amazon Q in Connect AI Guardrail.

Gets and Amazon Q in Connect AI Prompt.

Gets and Amazon Q in Connect AI Prompt.

Sourcemodule GetAssistantAssociationRequest = Awso_qconnect.Values.GetAssistantAssociationRequest

Retrieves information about an assistant association.

Sourcemodule GetAssistantAssociationResponse = Awso_qconnect.Values.GetAssistantAssociationResponse

Retrieves information about an assistant association.

Retrieves information about an assistant.

Retrieves information about an assistant.

Sourcemodule GetContentAssociationRequest = Awso_qconnect.Values.GetContentAssociationRequest

Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Sourcemodule GetContentAssociationResponse = Awso_qconnect.Values.GetContentAssociationResponse

Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Retrieves content, including a pre-signed URL to download the content.

Retrieves content, including a pre-signed URL to download the content.

Sourcemodule GetContentSummaryRequest = Awso_qconnect.Values.GetContentSummaryRequest

Retrieves summary information about the content.

Sourcemodule GetContentSummaryResponse = Awso_qconnect.Values.GetContentSummaryResponse

Retrieves summary information about the content.

Retrieves the started import job.

Summary information about the import job.

Retrieves the started import job.

Retrieves information about the knowledge base.

Sourcemodule GetKnowledgeBaseResponse = Awso_qconnect.Values.GetKnowledgeBaseResponse

Retrieves information about the knowledge base.

Sourcemodule GetMessageTemplateRequest = Awso_qconnect.Values.GetMessageTemplateRequest

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.

Sourcemodule GetMessageTemplateResponse = Awso_qconnect.Values.GetMessageTemplateResponse

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.

Retrieves next message on an Amazon Q in Connect session.

Sourcemodule UnprocessableContentException = Awso_qconnect.Values.UnprocessableContentException

The server has a failure of processing the message

A union type that specifies the data stored on the session.

The list of key-value pairs that are stored on the session.

Data about the result of tool usage.

The message data in text type.

The message data.

The message output.

Retrieves next message on an Amazon Q in Connect session.

Retrieves the quick response.

Sourcemodule GetQuickResponseResponse = Awso_qconnect.Values.GetQuickResponseResponse

Retrieves the quick response.

Sourcemodule GetRecommendationsRequest = Awso_qconnect.Values.GetRecommendationsRequest

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Sourcemodule RecommendationTriggerType = Awso_qconnect.Values.RecommendationTriggerType
Sourcemodule QueryRecommendationTriggerData = Awso_qconnect.Values.QueryRecommendationTriggerData

Data associated with the QUERY RecommendationTriggerType.

Sourcemodule RecommendationTriggerData = Awso_qconnect.Values.RecommendationTriggerData

A union type containing information related to the trigger.

Sourcemodule RecommendationSourceType = Awso_qconnect.Values.RecommendationSourceType

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

Sourcemodule RecommendationTriggerList = Awso_qconnect.Values.RecommendationTriggerList

Information about the recommendation.

Sourcemodule GetRecommendationsResponse = Awso_qconnect.Values.GetRecommendationsResponse

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Retrieves information for a specified session.

Retrieves information for a specified session.

Summary information about the import job.

Information about the Amazon Q intent.

Summary information about the knowledge base.

A knowledge source that provides content for recommendations.

Sourcemodule ListAIAgentVersionsRequest = Awso_qconnect.Values.ListAIAgentVersionsRequest

List AI Agent versions.

Sourcemodule ListAIAgentVersionsResponse = Awso_qconnect.Values.ListAIAgentVersionsResponse

List AI Agent versions.

Lists AI Agents.

Lists AI Agents.

Sourcemodule ListAIGuardrailVersionsRequest = Awso_qconnect.Values.ListAIGuardrailVersionsRequest

Lists AI Guardrail versions.

Sourcemodule ListAIGuardrailVersionsResponse = Awso_qconnect.Values.ListAIGuardrailVersionsResponse

Lists AI Guardrail versions.

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

Sourcemodule ListAIGuardrailsResponse = Awso_qconnect.Values.ListAIGuardrailsResponse

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

Sourcemodule ListAIPromptVersionsRequest = Awso_qconnect.Values.ListAIPromptVersionsRequest

Lists AI Prompt versions.

Sourcemodule ListAIPromptVersionsResponse = Awso_qconnect.Values.ListAIPromptVersionsResponse

Lists AI Prompt versions.

Lists the AI Prompts available on the Amazon Q in Connect assistant.

Lists the AI Prompts available on the Amazon Q in Connect assistant.

Sourcemodule ListAssistantAssociationsRequest = Awso_qconnect.Values.ListAssistantAssociationsRequest

Lists information about assistant associations.

Sourcemodule ListAssistantAssociationsResponse = Awso_qconnect.Values.ListAssistantAssociationsResponse

Lists information about assistant associations.

Lists information about assistants.

Lists information about assistants.

Sourcemodule ListContentAssociationsRequest = Awso_qconnect.Values.ListContentAssociationsRequest

Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Sourcemodule ListContentAssociationsResponse = Awso_qconnect.Values.ListContentAssociationsResponse

Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Lists the content.

Lists the content.

Lists information about import jobs.

Lists information about import jobs.

Sourcemodule ListKnowledgeBasesRequest = Awso_qconnect.Values.ListKnowledgeBasesRequest

Lists the knowledge bases.

Sourcemodule ListKnowledgeBasesResponse = Awso_qconnect.Values.ListKnowledgeBasesResponse

Lists the knowledge bases.

Sourcemodule ListMessageTemplateVersionsRequest = Awso_qconnect.Values.ListMessageTemplateVersionsRequest

Lists all the available versions for the specified Amazon Q in Connect message template.

Sourcemodule MessageTemplateVersionSummary = Awso_qconnect.Values.MessageTemplateVersionSummary

The summary of the message template version.

Sourcemodule MessageTemplateVersionSummaryList = Awso_qconnect.Values.MessageTemplateVersionSummaryList
Sourcemodule ListMessageTemplateVersionsResponse = Awso_qconnect.Values.ListMessageTemplateVersionsResponse

Lists all the available versions for the specified Amazon Q in Connect message template.

Sourcemodule ListMessageTemplatesRequest = Awso_qconnect.Values.ListMessageTemplatesRequest

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

The summary of the message template.

Sourcemodule MessageTemplateSummaryList = Awso_qconnect.Values.MessageTemplateSummaryList
Sourcemodule ListMessageTemplatesResponse = Awso_qconnect.Values.ListMessageTemplatesResponse

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

Lists messages on an Amazon Q in Connect session.

Lists messages on an Amazon Q in Connect session.

Lists the models available to an Amazon Q in Connect assistant in the assistant's Amazon Web Services Region. The available models are determined by the region of the specified assistant.

The summary of a model available to an Amazon Q in Connect assistant.

Lists the models available to an Amazon Q in Connect assistant in the assistant's Amazon Web Services Region. The available models are determined by the region of the specified assistant.

Sourcemodule ListQuickResponsesRequest = Awso_qconnect.Values.ListQuickResponsesRequest

Lists information about quick response.

The summary information about the quick response.

Sourcemodule QuickResponseSummaryList = Awso_qconnect.Values.QuickResponseSummaryList
Sourcemodule ListQuickResponsesResponse = Awso_qconnect.Values.ListQuickResponsesResponse

Lists information about quick response.

Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.

Sourcemodule SpanStatusDescriptionString = Awso_qconnect.Values.SpanStatusDescriptionString
Sourcemodule SpanOriginRequestIdString = Awso_qconnect.Values.SpanOriginRequestIdString

Tool invocation message content

A citation that spans a specific range of text.

Text message content

Model reasoning and it's internal decision making process

module SpanMessageValue = Awso_qconnect.Values.SpanMessageValue

Message content value - can be text, tool invocation, tool result, or reasoning

module SpanMessageValueList = Awso_qconnect.Values.SpanMessageValueList
module SpanToolResultValue = Awso_qconnect.Values.SpanToolResultValue

Tool result message content

A message in the conversation history with participant role and content values

Sourcemodule SpanAttributesTemperatureFloat = Awso_qconnect.Values.SpanAttributesTemperatureFloat

Contextual attributes capturing operation details, LLM configuration, usage metrics, and conversation data

A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.

Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.

Sourcemodule ListTagsForResourceRequest = Awso_qconnect.Values.ListTagsForResourceRequest

Lists the tags for the specified resource.

Sourcemodule ListTagsForResourceResponse = Awso_qconnect.Values.ListTagsForResourceResponse

Lists the tags for the specified resource.

The configuration for a SendMessage request.

The message input.

Sourcemodule MessageTemplateAttributeKeyList = Awso_qconnect.Values.MessageTemplateAttributeKeyList
Sourcemodule MessageTemplateFilterValue = Awso_qconnect.Values.MessageTemplateFilterValue
Sourcemodule MessageTemplateFilterValueList = Awso_qconnect.Values.MessageTemplateFilterValueList
Sourcemodule MessageTemplateFilterOperator = Awso_qconnect.Values.MessageTemplateFilterOperator
Sourcemodule MessageTemplateFilterField = Awso_qconnect.Values.MessageTemplateFilterField

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

Sourcemodule MessageTemplateFilterFieldList = Awso_qconnect.Values.MessageTemplateFilterFieldList
Sourcemodule MessageTemplateOrderField = Awso_qconnect.Values.MessageTemplateOrderField

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

Sourcemodule MessageTemplateQueryValue = Awso_qconnect.Values.MessageTemplateQueryValue
Sourcemodule MessageTemplateQueryValueList = Awso_qconnect.Values.MessageTemplateQueryValueList
Sourcemodule MessageTemplateQueryOperator = Awso_qconnect.Values.MessageTemplateQueryOperator
Sourcemodule MessageTemplateQueryField = Awso_qconnect.Values.MessageTemplateQueryField

The message template fields to query message templates by. The following is the list of supported field names: name description

Sourcemodule MessageTemplateQueryFieldList = Awso_qconnect.Values.MessageTemplateQueryFieldList
Sourcemodule MessageTemplateSearchExpression = Awso_qconnect.Values.MessageTemplateSearchExpression

The search expression of the message template.

Sourcemodule MessageTemplateSearchResultData = Awso_qconnect.Values.MessageTemplateSearchResultData

The result of message template search.

Sourcemodule MessageTemplateSearchResultsList = Awso_qconnect.Values.MessageTemplateSearchResultsList
Sourcemodule NotifyRecommendationsReceivedErrorMessage = Awso_qconnect.Values.NotifyRecommendationsReceivedErrorMessage
Sourcemodule NotifyRecommendationsReceivedError = Awso_qconnect.Values.NotifyRecommendationsReceivedError

An error occurred when creating a recommendation.

Sourcemodule NotifyRecommendationsReceivedErrorList = Awso_qconnect.Values.NotifyRecommendationsReceivedErrorList
Sourcemodule NotifyRecommendationsReceivedRequest = Awso_qconnect.Values.NotifyRecommendationsReceivedRequest

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Sourcemodule NotifyRecommendationsReceivedResponse = Awso_qconnect.Values.NotifyRecommendationsReceivedResponse

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Sourcemodule PreconditionFailedException = Awso_qconnect.Values.PreconditionFailedException

The provided revisionId does not match, indicating the content has been modified since it was last read.

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

Information about the text to search for.

Input information for the query.

Sourcemodule QueryConditionComparisonOperator = Awso_qconnect.Values.QueryConditionComparisonOperator

The condition for the query.

Information about how to query content.

Sourcemodule QueryConditionExpression = Awso_qconnect.Values.QueryConditionExpression

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

Information about the result.

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

Sourcemodule QuickResponseFilterValue = Awso_qconnect.Values.QuickResponseFilterValue
Sourcemodule QuickResponseFilterValueList = Awso_qconnect.Values.QuickResponseFilterValueList
Sourcemodule QuickResponseFilterOperator = Awso_qconnect.Values.QuickResponseFilterOperator
Sourcemodule QuickResponseFilterField = Awso_qconnect.Values.QuickResponseFilterField

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

Sourcemodule QuickResponseFilterFieldList = Awso_qconnect.Values.QuickResponseFilterFieldList

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

Sourcemodule QuickResponseQueryValueList = Awso_qconnect.Values.QuickResponseQueryValueList
Sourcemodule QuickResponseQueryOperator = Awso_qconnect.Values.QuickResponseQueryOperator

The quick response fields to query quick responses by. The following is the list of supported field names. content name description shortcutKey

Sourcemodule QuickResponseQueryFieldList = Awso_qconnect.Values.QuickResponseQueryFieldList
Sourcemodule QuickResponseSearchExpression = Awso_qconnect.Values.QuickResponseSearchExpression

Information about the import job.

Sourcemodule QuickResponseSearchResultData = Awso_qconnect.Values.QuickResponseSearchResultData

The result of quick response search.

Sourcemodule QuickResponseSearchResultsList = Awso_qconnect.Values.QuickResponseSearchResultsList
Sourcemodule RemoveAssistantAIAgentRequest = Awso_qconnect.Values.RemoveAssistantAIAgentRequest

Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Sourcemodule RemoveAssistantAIAgentResponse = Awso_qconnect.Values.RemoveAssistantAIAgentResponse

Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Sourcemodule RemoveKnowledgeBaseTemplateUriRequest = Awso_qconnect.Values.RemoveKnowledgeBaseTemplateUriRequest

Removes a URI template from a knowledge base.

Sourcemodule RemoveKnowledgeBaseTemplateUriResponse = Awso_qconnect.Values.RemoveKnowledgeBaseTemplateUriResponse

Removes a URI template from a knowledge base.

Sourcemodule RenderMessageTemplateRequest = Awso_qconnect.Values.RenderMessageTemplateRequest

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

Sourcemodule RenderMessageTemplateResponse = Awso_qconnect.Values.RenderMessageTemplateResponse

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

module RetrievalFilterConfiguration = Awso_qconnect.Values.RetrievalFilterConfiguration

Configuration for filtering content during retrieval operations.

module RetrievalFilterList = Awso_qconnect.Values.RetrievalFilterList

Configuration for content retrieval operations.

Retrieves content from knowledge sources based on a query.

A single result from a content retrieval operation.

Retrieves content from knowledge sources based on a query.

The search expression.

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Sourcemodule SearchMessageTemplatesRequest = Awso_qconnect.Values.SearchMessageTemplatesRequest

Searches for Amazon Q in Connect message templates in the specified knowledge base.

Sourcemodule SearchMessageTemplatesResponse = Awso_qconnect.Values.SearchMessageTemplatesResponse

Searches for Amazon Q in Connect message templates in the specified knowledge base.

Sourcemodule SearchQuickResponsesRequest = Awso_qconnect.Values.SearchQuickResponsesRequest

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

Sourcemodule SearchQuickResponsesResponse = Awso_qconnect.Values.SearchQuickResponsesResponse

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

Searches for sessions.

Summary information about the session.

Searches for sessions.

Sourcemodule SendMessageRequestOriginRequestIdString = Awso_qconnect.Values.SendMessageRequestOriginRequestIdString

Submits a message to the Amazon Q in Connect session.

Submits a message to the Amazon Q in Connect session.

Expiration time in minutes

Sourcemodule StartContentUploadRequest = Awso_qconnect.Values.StartContentUploadRequest

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Sourcemodule StartContentUploadResponse = Awso_qconnect.Values.StartContentUploadResponse

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

Adds the specified tags to the specified resource.

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

Adds the specified tags to the specified resource.

Removes the specified tags from the specified resource.

Removes the specified tags from the specified resource.

Updates an AI Agent.

Updates an AI Agent.

Sourcemodule UpdateAIGuardrailRequest = Awso_qconnect.Values.UpdateAIGuardrailRequest

Updates an AI Guardrail.

Sourcemodule UpdateAIGuardrailResponse = Awso_qconnect.Values.UpdateAIGuardrailResponse

Updates an AI Guardrail.

Updates an AI Prompt.

Updates an AI Prompt.

Sourcemodule UpdateAssistantAIAgentRequest = Awso_qconnect.Values.UpdateAssistantAIAgentRequest

Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Sourcemodule UpdateAssistantAIAgentResponse = Awso_qconnect.Values.UpdateAssistantAIAgentResponse

Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Updates information about the content.

Updates information about the content.

Sourcemodule UpdateKnowledgeBaseTemplateUriRequest = Awso_qconnect.Values.UpdateKnowledgeBaseTemplateUriRequest

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

Sourcemodule UpdateKnowledgeBaseTemplateUriResponse = Awso_qconnect.Values.UpdateKnowledgeBaseTemplateUriResponse

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

Sourcemodule UpdateMessageTemplateMetadataRequest = Awso_qconnect.Values.UpdateMessageTemplateMetadataRequest

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

Sourcemodule UpdateMessageTemplateMetadataResponse = Awso_qconnect.Values.UpdateMessageTemplateMetadataResponse

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

Sourcemodule UpdateMessageTemplateRequest = Awso_qconnect.Values.UpdateMessageTemplateRequest

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.

Sourcemodule UpdateMessageTemplateResponse = Awso_qconnect.Values.UpdateMessageTemplateResponse

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.

Sourcemodule UpdateQuickResponseRequest = Awso_qconnect.Values.UpdateQuickResponseRequest

Updates an existing Amazon Q in Connect quick response.

Sourcemodule UpdateQuickResponseResponse = Awso_qconnect.Values.UpdateQuickResponseResponse

Updates an existing Amazon Q in Connect quick response.

Sourcemodule UpdateSessionDataRequest = Awso_qconnect.Values.UpdateSessionDataRequest

Updates the data stored on an Amazon Q in Connect Session.

Sourcemodule UpdateSessionDataResponse = Awso_qconnect.Values.UpdateSessionDataResponse

Updates the data stored on an Amazon Q in Connect Session.

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.