Values (p.awso.0.9.1.doc.awso.qconnect.Awso

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule AIAgentAssociationConfigurationType : sig ... end

Sourcemodule UuidWithQualifier : sig ... end

Sourcemodule Uuid : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagCondition : sig ... end

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

Sourcemodule AndConditions : sig ... end

Sourcemodule OrCondition : sig ... end

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

Sourcemodule OrConditions : sig ... end

Sourcemodule TagFilter : sig ... end

An object that can be used to specify Tag conditions.

Sourcemodule MaxResults : sig ... end

Sourcemodule KnowledgeBaseSearchType : sig ... end

Sourcemodule KnowledgeBaseAssociationConfigurationData : sig ... end

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

Sourcemodule AssociationConfigurationData : sig ... end

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

Sourcemodule AssociationConfiguration : sig ... end

The configuration for an Amazon Q in Connect Assistant Association.

Sourcemodule AssociationConfigurationList : sig ... end

Sourcemodule SelfServiceAIAgentConfiguration : sig ... end

The configuration for AI Agents of type SELF_SERVICE.

Sourcemodule Boolean : sig ... end

Sourcemodule UserInteractionConfiguration : sig ... end

Configuration for user interaction settings.

Sourcemodule ToolType : sig ... end

Sourcemodule ToolOverrideInputValueType : sig ... end

Sourcemodule NonEmptySensitiveString : sig ... end

Sourcemodule ToolOverrideConstantInputValue : sig ... end

A constant input value for tool override.

Sourcemodule ToolOverrideInputValueConfiguration : sig ... end

Configuration for overriding tool input values.

Sourcemodule NonEmptyString : sig ... end

Sourcemodule ToolOverrideInputValue : sig ... end

An input value override for tools.

Sourcemodule ToolOverrideInputValueList : sig ... end

Sourcemodule ToolOutputConfiguration : sig ... end

Configuration for tool output handling.

Sourcemodule ToolOutputFilter : sig ... end

Filter configuration for tool output.

Sourcemodule ToolOutputFilterList : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule ToolExampleList : sig ... end

Sourcemodule ToolInstruction : sig ... end

Instructions for using a tool.

Sourcemodule JSONDocument : sig ... end

Sourcemodule Annotation : sig ... end

An annotation that provides additional context or metadata.

Sourcemodule ToolConfiguration : sig ... end

Configuration settings for a tool used by AI Agents.

Sourcemodule ToolConfigurationList : sig ... end

Sourcemodule GenericArn : sig ... end

Sourcemodule OrchestrationAIAgentConfiguration : sig ... end

The configuration for AI Agents of type ORCHESTRATION.

Sourcemodule NoteTakingAIAgentConfiguration : sig ... end

The configuration for AI Agents of type NOTE_TAKING.

Sourcemodule ManualSearchAIAgentConfiguration : sig ... end

The configuration for the MANUAL_SEARCH AI Agent type.

Sourcemodule EmailResponseAIAgentConfiguration : sig ... end

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

Sourcemodule EmailOverviewAIAgentConfiguration : sig ... end

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

Sourcemodule EmailGenerativeAnswerAIAgentConfiguration : sig ... end

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

Sourcemodule CaseSummarizationAIAgentConfiguration : sig ... end

The configuration for AI Agents of type CASE_SUMMARIZATION.

Sourcemodule SuggestedMessagesList : sig ... end

Sourcemodule AnswerRecommendationAIAgentConfiguration : sig ... end

The configuration for the ANSWER_RECOMMENDATION AI Agent type.

Sourcemodule AIAgentConfiguration : sig ... end

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

Sourcemodule AIAgentConfigurationData : sig ... end

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.

Sourcemodule AIAgentType : sig ... end

Sourcemodule AIAgentConfigurationMap : sig ... end

Sourcemodule VisibilityStatus : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule Tags : sig ... end

Sourcemodule Status : sig ... end

Sourcemodule Origin : sig ... end

Sourcemodule Name : sig ... end

Sourcemodule Description : sig ... end

Sourcemodule Arn : sig ... end

Sourcemodule AIAgentData : sig ... end

The data for the AI Agent.

Sourcemodule AIAgentSummary : sig ... end

The summary of the AI Agent.

Sourcemodule AIAgentSummaryList : sig ... end

Sourcemodule Version : sig ... end

Sourcemodule AIAgentVersionSummary : sig ... end

The summary of the AI Agent version.

Sourcemodule AIAgentVersionSummariesList : sig ... end

Sourcemodule AIGuardrailAssessment : sig ... end

The assessment information from the AI Guardrail.

Sourcemodule AIGuardrailBlockedMessaging : sig ... end

Messaging for when violations are detected in text

Sourcemodule GuardrailFilterStrength : sig ... end

Sourcemodule GuardrailContentFilterType : sig ... end

Sourcemodule GuardrailContentFilterConfig : sig ... end

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 : sig ... end

Sourcemodule AIGuardrailContentPolicyConfig : sig ... end

Contains details about how to handle harmful content.

Sourcemodule GuardrailContextualGroundingFilterType : sig ... end

Sourcemodule GuardrailContextualGroundingFilterThreshold : sig ... end

The threshold for this filter.

Sourcemodule GuardrailContextualGroundingFilterConfig : sig ... end

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

Sourcemodule GuardrailContextualGroundingFiltersConfig : sig ... end

Sourcemodule AIGuardrailContextualGroundingPolicyConfig : sig ... end

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

Sourcemodule GuardrailWordText : sig ... end

The custom word text.

Sourcemodule GuardrailWordConfig : sig ... end

A word to configure for the AI Guardrail.

Sourcemodule GuardrailWordsConfig : sig ... end

Sourcemodule GuardrailManagedWordsType : sig ... end

Sourcemodule GuardrailManagedWordsConfig : sig ... end

The managed word list to configure for the AI Guardrail.

Sourcemodule GuardrailManagedWordListsConfig : sig ... end

Sourcemodule AIGuardrailWordPolicyConfig : sig ... end

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

Sourcemodule GuardrailTopicType : sig ... end

Sourcemodule GuardrailTopicName : sig ... end

Name of topic in topic policy

Sourcemodule GuardrailTopicExample : sig ... end

Text example in topic policy

Sourcemodule GuardrailTopicExamples : sig ... end

Sourcemodule GuardrailTopicDefinition : sig ... end

Definition of topic in topic policy

Sourcemodule GuardrailTopicConfig : sig ... end

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

Sourcemodule GuardrailTopicsConfig : sig ... end

Sourcemodule AIGuardrailTopicPolicyConfig : sig ... end

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

Sourcemodule GuardrailSensitiveInformationAction : sig ... end

Sourcemodule GuardrailRegexPattern : sig ... end

The regex pattern.

Sourcemodule GuardrailRegexName : sig ... end

The regex name.

Sourcemodule GuardrailRegexDescription : sig ... end

The regex description.

Sourcemodule GuardrailRegexConfig : sig ... end

The regular expression to configure for the AI Guardrail.

Sourcemodule GuardrailRegexesConfig : sig ... end

Sourcemodule GuardrailPiiEntityType : sig ... end

Sourcemodule GuardrailPiiEntityConfig : sig ... end

The PII entity to configure for the AI Guardrail.

Sourcemodule GuardrailPiiEntitiesConfig : sig ... end

Sourcemodule AIGuardrailSensitiveInformationPolicyConfig : sig ... end

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

Sourcemodule AIGuardrailDescription : sig ... end

Description of the guardrail or its version

Sourcemodule AIGuardrailData : sig ... end

The data for the AI Guardrail

Sourcemodule AIGuardrailSummary : sig ... end

The summary of the AI Guardrail.

Sourcemodule AIGuardrailSummariesList : sig ... end

Sourcemodule AIGuardrailVersionSummary : sig ... end

The summary of the AI Guardrail version.

Sourcemodule AIGuardrailVersionSummariesList : sig ... end

Sourcemodule AIPromptAPIFormat : sig ... end

Sourcemodule AIPromptType : sig ... end

Sourcemodule AIPromptTemplateType : sig ... end

Sourcemodule TextAIPrompt : sig ... end

Sourcemodule TextFullAIPromptEditTemplateConfiguration : sig ... end

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

Sourcemodule AIPromptTemplateConfiguration : sig ... end

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

Sourcemodule AIPromptModelIdentifier : sig ... end

Sourcemodule TopK : sig ... end

Sourcemodule Probability : sig ... end

Sourcemodule MaxTokensToSample : sig ... end

Sourcemodule AIPromptInferenceConfiguration : sig ... end

The configuration for inference parameters when using AI Prompts.

Sourcemodule AIPromptData : sig ... end

The data for the AI Prompt

Sourcemodule AIPromptSummary : sig ... end

The summary of the AI Prompt.

Sourcemodule AIPromptSummaryList : sig ... end

Sourcemodule AIPromptTypeList : sig ... end

Sourcemodule AIPromptVersionSummary : sig ... end

The summary of the AI Prompt version.

Sourcemodule AIPromptVersionSummariesList : sig ... end

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule AccessRoleArn : sig ... end

Sourcemodule UuidOrArnOrEitherWithQualifier : sig ... end

Sourcemodule UuidOrArn : sig ... end

Sourcemodule ActivateMessageTemplateRequest : sig ... end

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 ValidationException : sig ... end

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

Sourcemodule ThrottlingException : sig ... end

The throttling limit has been exceeded.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource does not exist.

Sourcemodule ConflictException : sig ... end

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 ArnWithQualifier : sig ... end

Sourcemodule ActivateMessageTemplateResponse : sig ... end

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 : sig ... end

Sourcemodule AgentAttributes : sig ... end

Information about an agent.

Sourcemodule AmazonConnectGuideAssociationData : sig ... end

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

Sourcemodule ObjectFieldsList : sig ... end

Sourcemodule AppIntegrationsConfiguration : sig ... end

Configuration information for Amazon AppIntegrations to automatically ingest content.

Sourcemodule AssociationType : sig ... end

Sourcemodule KnowledgeBaseAssociationData : sig ... end

Association information about the knowledge base.

Sourcemodule BedrockKnowledgeBaseArn : sig ... end

Sourcemodule ExternalBedrockKnowledgeBaseConfig : sig ... end

Configuration for an external Bedrock knowledge base.

Sourcemodule AssistantAssociationOutputData : sig ... end

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

Sourcemodule AssistantAssociationData : sig ... end

Information about the assistant association.

Sourcemodule AssistantAssociationIdList : sig ... end

Sourcemodule AssistantAssociationInputData : sig ... end

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

Sourcemodule AssistantAssociationSummary : sig ... end

Summary information about the assistant association.

Sourcemodule AssistantAssociationSummaryList : sig ... end

Sourcemodule AssistantCapabilityType : sig ... end

Sourcemodule AssistantCapabilityConfiguration : sig ... end

The capability configuration for an Amazon Q in Connect assistant.

Sourcemodule ServerSideEncryptionConfiguration : sig ... end

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

Sourcemodule OrchestratorConfigurationEntry : sig ... end

An entry in the orchestrator configuration list.

Sourcemodule OrchestratorConfigurationList : sig ... end

Sourcemodule AssistantType : sig ... end

Sourcemodule AssistantStatus : sig ... end

Sourcemodule AssistantIntegrationConfiguration : sig ... end

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

Sourcemodule AssistantData : sig ... end

The assistant data.

Sourcemodule AssistantSummary : sig ... end

Summary information about the assistant.

Sourcemodule AssistantList : sig ... end

Sourcemodule AttachmentFileName : sig ... end

Sourcemodule ParsingPromptText : sig ... end

Sourcemodule ParsingPrompt : sig ... end

Instructions for interpreting the contents of a document.

Sourcemodule BedrockModelArnForParsing : sig ... end

Sourcemodule BedrockFoundationModelConfigurationForParsing : sig ... end

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

Sourcemodule CaseArn : sig ... end

Sourcemodule NextToken : sig ... end

Sourcemodule CaseSummarizationChunkDataDetails : sig ... end

Details about case summarization chunk data.

Sourcemodule CaseSummarizationInputData : sig ... end

Input data for case summarization.

Sourcemodule Channel : sig ... end

Sourcemodule ChannelSubtype : sig ... end

Sourcemodule Channels : sig ... end

Sourcemodule SemanticChunkingConfigurationMaxTokensInteger : sig ... end

Sourcemodule SemanticChunkingConfigurationBufferSizeInteger : sig ... end

Source

module SemanticChunkingConfigurationBreakpointPercentileThresholdInteger : 
  sig ... end

Sourcemodule SemanticChunkingConfiguration : sig ... end

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 : sig ... end

Sourcemodule HierarchicalChunkingLevelConfiguration : sig ... end

Token settings for each layer.

Sourcemodule HierarchicalChunkingLevelConfigurations : sig ... end

Sourcemodule HierarchicalChunkingConfigurationOverlapTokensInteger : sig ... end

Sourcemodule HierarchicalChunkingConfiguration : sig ... end

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 : sig ... end

Sourcemodule FixedSizeChunkingConfigurationMaxTokensInteger : sig ... end

Sourcemodule FixedSizeChunkingConfiguration : sig ... end

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

Sourcemodule ChunkingStrategy : sig ... end

Sourcemodule ChunkingConfiguration : sig ... end

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.

Sourcemodule SensitiveString : sig ... end

Sourcemodule ReferenceType : sig ... end

Sourcemodule CitationSpanOffset : sig ... end

Sourcemodule CitationSpan : sig ... end

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

Sourcemodule Citation : sig ... end

A citation that references source content.

Sourcemodule Citations : sig ... end

Sourcemodule ClientToken : sig ... end

Sourcemodule ConnectConfiguration : sig ... end

The configuration information of the Amazon Connect data source.

Sourcemodule Configuration : sig ... end

The configuration information of the external data source.

Sourcemodule ContactAttributeKey : sig ... end

Sourcemodule ContactAttributeKeys : sig ... end

Sourcemodule ContactAttributeValue : sig ... end

Sourcemodule ContactAttributes : sig ... end

Sourcemodule ContentAssociationContents : sig ... end

The contents of a content association.

Sourcemodule ContentAssociationType : sig ... end

Sourcemodule ContentAssociationData : sig ... end

Information about the content association.

Sourcemodule ContentAssociationSummary : sig ... end

Summary information about a content association.

Sourcemodule ContentAssociationSummaryList : sig ... end

Sourcemodule Url : sig ... end

Sourcemodule Uri_ : sig ... end

Sourcemodule SyntheticTimestamp_epoch_seconds : sig ... end

Sourcemodule ContentType : sig ... end

Sourcemodule ContentTitle : sig ... end

Sourcemodule ContentStatus : sig ... end

Sourcemodule ContentMetadata : sig ... end

Sourcemodule ContentData : sig ... end

Information about the content.

Sourcemodule HighlightOffset : sig ... end

Sourcemodule Highlight : sig ... end

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

Sourcemodule Highlights : sig ... end

Sourcemodule DocumentText : sig ... end

The text of the document.

Sourcemodule TextData : sig ... end

Details about the source content text data.

Sourcemodule RelevanceScore : sig ... end

Sourcemodule RelevanceLevel : sig ... end

Sourcemodule RankingData : sig ... end

Details about the source content ranking data.

Sourcemodule ContentDataDetails : sig ... end

Details about the content data.

Sourcemodule ContentDisposition : sig ... end

Sourcemodule Relevance : sig ... end

Sourcemodule GenerativeContentFeedbackData : sig ... end

The feedback information for a generative target type.

Sourcemodule ContentFeedbackData : sig ... end

Information about the feedback.

Sourcemodule ContentReference : sig ... end

Reference information about the content.

Sourcemodule ContentSummary : sig ... end

Summary information about the content.

Sourcemodule ContentSummaryList : sig ... end

Sourcemodule Integer : sig ... end

Sourcemodule SelfServiceConversationHistory : sig ... end

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

Sourcemodule SelfServiceConversationHistoryList : sig ... end

Sourcemodule ConversationContext : sig ... end

The conversation context to include in SendMessage.

Sourcemodule ConversationStatusReason : sig ... end

Sourcemodule ConversationStatus : sig ... end

Sourcemodule ConversationState : sig ... end

The conversation state associated to a message.

Sourcemodule CreateAIAgentRequest : sig ... end

Creates an Amazon Q in Connect AI Agent.

Sourcemodule UnauthorizedException : sig ... end

You do not have permission to perform this action.

Sourcemodule ServiceQuotaExceededException : sig ... end

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.

Sourcemodule CreateAIAgentResponse : sig ... end

Creates an Amazon Q in Connect AI Agent.

Sourcemodule CreateAIAgentVersionRequest : sig ... end

Creates and Amazon Q in Connect AI Agent version.

Sourcemodule CreateAIAgentVersionResponse : sig ... end

Creates and Amazon Q in Connect AI Agent version.

Sourcemodule CreateAIGuardrailRequest : sig ... end

Creates an Amazon Q in Connect AI Guardrail.

Sourcemodule CreateAIGuardrailResponse : sig ... end

Creates an Amazon Q in Connect AI Guardrail.

Sourcemodule CreateAIGuardrailVersionRequest : sig ... end

Creates an Amazon Q in Connect AI Guardrail version.

Sourcemodule CreateAIGuardrailVersionResponse : sig ... end

Creates an Amazon Q in Connect AI Guardrail version.

Sourcemodule CreateAIPromptRequest : sig ... end

Creates an Amazon Q in Connect AI Prompt.

Sourcemodule CreateAIPromptResponse : sig ... end

Creates an Amazon Q in Connect AI Prompt.

Sourcemodule CreateAIPromptVersionRequest : sig ... end

Creates an Amazon Q in Connect AI Prompt version.

Sourcemodule CreateAIPromptVersionResponse : sig ... end

Creates an Amazon Q in Connect AI Prompt version.

Sourcemodule CreateAssistantAssociationRequest : sig ... end

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 : sig ... end

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 CreateAssistantRequest : sig ... end

Creates an Amazon Q in Connect assistant.

Sourcemodule CreateAssistantResponse : sig ... end

Creates an Amazon Q in Connect assistant.

Sourcemodule CreateContentAssociationRequest : sig ... end

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 : sig ... end

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 UploadId : sig ... end

Sourcemodule CreateContentRequest : sig ... end

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

Sourcemodule CreateContentResponse : sig ... end

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

Sourcemodule ParsingStrategy : sig ... end

Sourcemodule ParsingConfiguration : sig ... end

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 : sig ... end

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

Sourcemodule WebScopeType : sig ... end

Sourcemodule WebCrawlerLimitsRateLimitInteger : sig ... end

Sourcemodule WebCrawlerLimits : sig ... end

The configuration of crawl limits for the web URLs.

Sourcemodule UrlFilterPattern : sig ... end

Sourcemodule UrlFilterList : sig ... end

Sourcemodule WebUrl : sig ... end

Sourcemodule SeedUrl : sig ... end

A URL for crawling.

Sourcemodule SeedUrls : sig ... end

Sourcemodule UrlConfiguration : sig ... end

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

Sourcemodule WebCrawlerConfiguration : sig ... end

The configuration details for the web data source.

Sourcemodule ManagedSourceConfiguration : sig ... end

Source configuration for managed resources.

Sourcemodule SourceConfiguration : sig ... end

Configuration information about the external data source.

Sourcemodule RenderingConfiguration : sig ... end

Information about how to render the content.

Sourcemodule KnowledgeBaseType : sig ... end

Sourcemodule CreateKnowledgeBaseRequest : sig ... end

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 SyncStatus : sig ... end

Sourcemodule KnowledgeBaseStatus : sig ... end

Sourcemodule FailureReason : sig ... end

Sourcemodule KnowledgeBaseData : sig ... end

Information about the knowledge base.

Sourcemodule CreateKnowledgeBaseResponse : sig ... end

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 NonEmptyUnlimitedString : sig ... end

Sourcemodule CreateMessageTemplateAttachmentRequest : sig ... end

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 : sig ... end

Sourcemodule MessageTemplateAttachment : sig ... end

Information about the message template attachment.

Sourcemodule CreateMessageTemplateAttachmentResponse : sig ... end

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 : sig ... end

Sourcemodule WhatsAppMessageTemplateComponent : sig ... end

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

Sourcemodule WhatsAppMessageTemplateComponents : sig ... end

Sourcemodule WhatsAppBusinessAccountId : sig ... end

Sourcemodule WhatsAppMessageTemplateSourceConfiguration : sig ... end

Configuration information about the external data source.

Sourcemodule MessageTemplateSourceConfiguration : sig ... end

The container of message template source configuration.

Sourcemodule WhatsAppMessageTemplateContentData : sig ... end

Sourcemodule WhatsAppMessageTemplateContent : sig ... end

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

Sourcemodule MessageTemplateBodyContentProvider : sig ... end

The container of the message template body.

Sourcemodule SMSMessageTemplateContentBody : sig ... end

The body to use in SMS messages.

Sourcemodule SMSMessageTemplateContent : sig ... end

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

Sourcemodule PushMessageAction : sig ... end

Sourcemodule PushFCMMessageTemplateContent : sig ... end

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

Sourcemodule PushBaiduMessageTemplateContent : sig ... end

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

Sourcemodule PushAPNSMessageTemplateContent : sig ... end

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

Sourcemodule PushADMMessageTemplateContent : sig ... end

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

Sourcemodule PushMessageTemplateContent : sig ... end

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

Sourcemodule EmailMessageTemplateContentBody : sig ... end

The body to use in email messages.

Sourcemodule EmailHeaderValue : sig ... end

Sourcemodule EmailHeaderKey : sig ... end

Sourcemodule EmailHeader : sig ... end

The email header to include in email messages.

Sourcemodule EmailHeaders : sig ... end

Sourcemodule EmailMessageTemplateContent : sig ... end

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

Sourcemodule MessageTemplateContentProvider : sig ... end

The container of message template content.

Sourcemodule SystemEndpointAttributes : sig ... end

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

Sourcemodule SystemAttributes : sig ... end

The system attributes that are used with the message template.

Sourcemodule MessageTemplateAttributeKey : sig ... end

Sourcemodule CustomAttributes : sig ... end

Sourcemodule CustomerProfileAttributes : sig ... end

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

Sourcemodule MessageTemplateAttributes : sig ... end

The attributes that are used with the message template.

Sourcemodule LanguageCode : sig ... end

Sourcemodule GroupingValue : sig ... end

Sourcemodule GroupingValues : sig ... end

Sourcemodule GroupingCriteria : sig ... end

Sourcemodule GroupingConfiguration : sig ... end

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

Sourcemodule CreateMessageTemplateRequest : sig ... end

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 : sig ... end

Sourcemodule WhatsAppMessageTemplateName : sig ... end

Sourcemodule WhatsAppMessageTemplateLanguage : sig ... end

Sourcemodule WhatsAppMessageTemplateSourceConfigurationSummary : sig ... end

Configuration information about the external data source.

Sourcemodule MessageTemplateSourceConfigurationSummary : sig ... end

The container of message template source configuration summary.

Sourcemodule MessageTemplateContentSha256 : sig ... end

Sourcemodule MessageTemplateAttributeType : sig ... end

Sourcemodule MessageTemplateAttributeTypeList : sig ... end

Sourcemodule MessageTemplateData : sig ... end

The data of a message template.

Sourcemodule CreateMessageTemplateResponse : sig ... end

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 : sig ... end

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 : sig ... end

Sourcemodule ExtendedMessageTemplateData : sig ... end

The extended data of a message template.

Sourcemodule CreateMessageTemplateVersionResponse : sig ... end

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 ShortCutKey : sig ... end

Sourcemodule QuickResponseType : sig ... end

Sourcemodule QuickResponseName : sig ... end

Sourcemodule QuickResponseDescription : sig ... end

Sourcemodule QuickResponseContent : sig ... end

Sourcemodule QuickResponseDataProvider : sig ... end

The container of quick response data.

Sourcemodule CreateQuickResponseRequest : sig ... end

Creates an Amazon Q in Connect quick response.

Sourcemodule QuickResponseStatus : sig ... end

Sourcemodule QuickResponseContentProvider : sig ... end

The container quick response content.

Sourcemodule QuickResponseContents : sig ... end

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

Sourcemodule QuickResponseData : sig ... end

Information about the quick response.

Sourcemodule CreateQuickResponseResponse : sig ... end

Creates an Amazon Q in Connect quick response.

Sourcemodule CreateSessionRequest : sig ... end

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 : sig ... end

The configuration information for the session integration.

Sourcemodule SessionData : sig ... end

Information about the session.

Sourcemodule DependencyFailedException : sig ... end

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

Sourcemodule CreateSessionResponse : sig ... end

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 CrossRegionStatus : sig ... end

Sourcemodule SuggestedMessageDataDetails : sig ... end

Details about suggested message data.

Sourcemodule SourceContentType : sig ... end

Sourcemodule SourceContentDataDetails : sig ... end

Details about the source content data.

Sourcemodule NotesDataDetails : sig ... end

Details about notes data.

Sourcemodule NotesChunkDataDetails : sig ... end

Details about notes chunk data.

Sourcemodule IntentDetectedDataDetails : sig ... end

Details about the detected intent.

Sourcemodule SuggestedMessageReference : sig ... end

Reference information for a suggested message.

Sourcemodule LlmModelId : sig ... end

Sourcemodule GenerativeReference : sig ... end

Reference information about generative content.

Sourcemodule DataReference : sig ... end

Reference data.

Sourcemodule EmailResponseChunkDataDetails : sig ... end

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

Sourcemodule EmailOverviewChunkDataDetails : sig ... end

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

module DataDetails : sig ... end

Details about the data.

module DataSummary : sig ... end

Summary of the data.

module DataSummaryList : sig ... end

module EmailGenerativeAnswerChunkDataDetails : sig ... end

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

module GenerativeChunkDataDetails : sig ... end

Details about the generative chunk data.

module GenerativeDataDetails : sig ... end

Details about generative data.

Sourcemodule DeactivateMessageTemplateRequest : sig ... end

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 : sig ... end

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 DeleteAIAgentRequest : sig ... end

Deletes an Amazon Q in Connect AI Agent.

Sourcemodule DeleteAIAgentResponse : sig ... end

Deletes an Amazon Q in Connect AI Agent.

Sourcemodule DeleteAIAgentVersionRequest : sig ... end

Deletes an Amazon Q in Connect AI Agent Version.

Sourcemodule DeleteAIAgentVersionResponse : sig ... end

Deletes an Amazon Q in Connect AI Agent Version.

Sourcemodule DeleteAIGuardrailRequest : sig ... end

Deletes an Amazon Q in Connect AI Guardrail.

Sourcemodule DeleteAIGuardrailResponse : sig ... end

Deletes an Amazon Q in Connect AI Guardrail.

Sourcemodule DeleteAIGuardrailVersionRequest : sig ... end

Delete and Amazon Q in Connect AI Guardrail version.

Sourcemodule DeleteAIGuardrailVersionResponse : sig ... end

Delete and Amazon Q in Connect AI Guardrail version.

Sourcemodule DeleteAIPromptRequest : sig ... end

Deletes an Amazon Q in Connect AI Prompt.

Sourcemodule DeleteAIPromptResponse : sig ... end

Deletes an Amazon Q in Connect AI Prompt.

Sourcemodule DeleteAIPromptVersionRequest : sig ... end

Delete and Amazon Q in Connect AI Prompt version.

Sourcemodule DeleteAIPromptVersionResponse : sig ... end

Delete and Amazon Q in Connect AI Prompt version.

Sourcemodule DeleteAssistantAssociationRequest : sig ... end

Deletes an assistant association.

Sourcemodule DeleteAssistantAssociationResponse : sig ... end

Deletes an assistant association.

Sourcemodule DeleteAssistantRequest : sig ... end

Deletes an assistant.

Sourcemodule DeleteAssistantResponse : sig ... end

Deletes an assistant.

Sourcemodule DeleteContentAssociationRequest : sig ... end

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 : sig ... end

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 DeleteContentRequest : sig ... end

Deletes the content.

Sourcemodule DeleteContentResponse : sig ... end

Deletes the content.

Sourcemodule DeleteImportJobRequest : sig ... end

Deletes the quick response import job.

Sourcemodule DeleteImportJobResponse : sig ... end

Deletes the quick response import job.

Sourcemodule DeleteKnowledgeBaseRequest : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

Deletes a quick response.

Sourcemodule DeleteQuickResponseResponse : sig ... end

Deletes a quick response.

Sourcemodule Document : sig ... end

The document.

Sourcemodule ExternalSource : sig ... end

Sourcemodule ExternalSourceConfiguration : sig ... end

The configuration information of the external data source.

Sourcemodule FilterOperator : sig ... end

Sourcemodule FilterField : sig ... end

Sourcemodule Filter : sig ... end

A search filter.

Sourcemodule FilterAttributeKey : sig ... end

Sourcemodule FilterAttribute : sig ... end

An attribute used for filtering.

Sourcemodule FilterList : sig ... end

Sourcemodule GetAIAgentRequest : sig ... end

Gets an Amazon Q in Connect AI Agent.

Sourcemodule GetAIAgentResponse : sig ... end

Gets an Amazon Q in Connect AI Agent.

Sourcemodule GetAIGuardrailRequest : sig ... end

Gets the Amazon Q in Connect AI Guardrail.

Sourcemodule GetAIGuardrailResponse : sig ... end

Gets the Amazon Q in Connect AI Guardrail.

Sourcemodule GetAIPromptRequest : sig ... end

Gets and Amazon Q in Connect AI Prompt.

Sourcemodule GetAIPromptResponse : sig ... end

Gets and Amazon Q in Connect AI Prompt.

Sourcemodule GetAssistantAssociationRequest : sig ... end

Retrieves information about an assistant association.

Sourcemodule GetAssistantAssociationResponse : sig ... end

Retrieves information about an assistant association.

Sourcemodule GetAssistantRequest : sig ... end

Retrieves information about an assistant.

Sourcemodule GetAssistantResponse : sig ... end

Retrieves information about an assistant.

Sourcemodule GetContentAssociationRequest : sig ... end

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 : sig ... end

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 GetContentRequest : sig ... end

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

Sourcemodule GetContentResponse : sig ... end

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

Sourcemodule GetContentSummaryRequest : sig ... end

Retrieves summary information about the content.

Sourcemodule GetContentSummaryResponse : sig ... end

Retrieves summary information about the content.

Sourcemodule GetImportJobRequest : sig ... end

Retrieves the started import job.

Sourcemodule ImportJobType : sig ... end

Sourcemodule ImportJobStatus : sig ... end

Sourcemodule ImportJobData : sig ... end

Summary information about the import job.

Sourcemodule GetImportJobResponse : sig ... end

Retrieves the started import job.

Sourcemodule GetKnowledgeBaseRequest : sig ... end

Retrieves information about the knowledge base.

Sourcemodule GetKnowledgeBaseResponse : sig ... end

Retrieves information about the knowledge base.

Sourcemodule GetMessageTemplateRequest : sig ... end

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 : sig ... end

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 GetNextMessageRequest : sig ... end

Retrieves next message on an Amazon Q in Connect session.

Sourcemodule UnprocessableContentException : sig ... end

The server has a failure of processing the message

Sourcemodule RuntimeSessionDataValue : sig ... end

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

Sourcemodule RuntimeSessionData : sig ... end

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

Sourcemodule RuntimeSessionDataList : sig ... end

Sourcemodule MessageType : sig ... end

Sourcemodule Participant : sig ... end

Sourcemodule ToolUseResultData : sig ... end

Data about the result of tool usage.

Sourcemodule TextMessageValueString : sig ... end

Sourcemodule TextMessage : sig ... end

The message data in text type.

Sourcemodule MessageData : sig ... end

The message data.

Sourcemodule MessageOutput : sig ... end

The message output.

Sourcemodule GetNextMessageResponse : sig ... end

Retrieves next message on an Amazon Q in Connect session.

Sourcemodule GetQuickResponseRequest : sig ... end

Retrieves the quick response.

Sourcemodule GetQuickResponseResponse : sig ... end

Retrieves the quick response.

Sourcemodule WaitTimeSeconds : sig ... end

Sourcemodule RecommendationType : sig ... end

Sourcemodule GetRecommendationsRequest : sig ... end

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 : sig ... end

Sourcemodule QueryText : sig ... end

Sourcemodule QueryRecommendationTriggerData : sig ... end

Data associated with the QUERY RecommendationTriggerType.

Sourcemodule RecommendationTriggerData : sig ... end

A union type containing information related to the trigger.

Sourcemodule RecommendationSourceType : sig ... end

Sourcemodule RecommendationId : sig ... end

Sourcemodule RecommendationIdList : sig ... end

Sourcemodule RecommendationTrigger : sig ... end

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 : sig ... end

Sourcemodule RecommendationData : sig ... end

Information about the recommendation.

Sourcemodule RecommendationList : sig ... end

Sourcemodule GetRecommendationsResponse : sig ... end

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 GetSessionRequest : sig ... end

Retrieves information for a specified session.

Sourcemodule GetSessionResponse : sig ... end

Retrieves information for a specified session.

Sourcemodule Headers : sig ... end

Sourcemodule ImportJobSummary : sig ... end

Summary information about the import job.

Sourcemodule ImportJobList : sig ... end

Sourcemodule IntentInputData : sig ... end

Information about the Amazon Q intent.

Sourcemodule KnowledgeBaseSummary : sig ... end

Summary information about the knowledge base.

Sourcemodule KnowledgeBaseList : sig ... end

Sourcemodule KnowledgeSource : sig ... end

A knowledge source that provides content for recommendations.

Sourcemodule ListAIAgentVersionsRequest : sig ... end

List AI Agent versions.

Sourcemodule ListAIAgentVersionsResponse : sig ... end

List AI Agent versions.

Sourcemodule ListAIAgentsRequest : sig ... end

Lists AI Agents.

Sourcemodule ListAIAgentsResponse : sig ... end

Lists AI Agents.

Sourcemodule ListAIGuardrailVersionsRequest : sig ... end

Lists AI Guardrail versions.

Sourcemodule ListAIGuardrailVersionsResponse : sig ... end

Lists AI Guardrail versions.

Sourcemodule ListAIGuardrailsRequest : sig ... end

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

Sourcemodule ListAIGuardrailsResponse : sig ... end

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

Sourcemodule ListAIPromptVersionsRequest : sig ... end

Lists AI Prompt versions.

Sourcemodule ListAIPromptVersionsResponse : sig ... end

Lists AI Prompt versions.

Sourcemodule ListAIPromptsRequest : sig ... end

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

Sourcemodule ListAIPromptsResponse : sig ... end

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

Sourcemodule ListAssistantAssociationsRequest : sig ... end

Lists information about assistant associations.

Sourcemodule ListAssistantAssociationsResponse : sig ... end

Lists information about assistant associations.

Sourcemodule ListAssistantsRequest : sig ... end

Lists information about assistants.

Sourcemodule ListAssistantsResponse : sig ... end

Lists information about assistants.

Sourcemodule ListContentAssociationsRequest : sig ... end

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 : sig ... end

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 ListContentsRequest : sig ... end

Lists the content.

Sourcemodule ListContentsResponse : sig ... end

Lists the content.

Sourcemodule ListImportJobsRequest : sig ... end

Lists information about import jobs.

Sourcemodule ListImportJobsResponse : sig ... end

Lists information about import jobs.

Sourcemodule ListKnowledgeBasesRequest : sig ... end

Lists the knowledge bases.

Sourcemodule ListKnowledgeBasesResponse : sig ... end

Lists the knowledge bases.

Sourcemodule ListMessageTemplateVersionsRequest : sig ... end

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

Sourcemodule MessageTemplateVersionSummary : sig ... end

The summary of the message template version.

Sourcemodule MessageTemplateVersionSummaryList : sig ... end

Sourcemodule ListMessageTemplateVersionsResponse : sig ... end

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

Sourcemodule ListMessageTemplatesRequest : sig ... end

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

Sourcemodule MessageTemplateSummary : sig ... end

The summary of the message template.

Sourcemodule MessageTemplateSummaryList : sig ... end

Sourcemodule ListMessageTemplatesResponse : sig ... end

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

Sourcemodule MessageFilterType : sig ... end

Sourcemodule ListMessagesRequest : sig ... end

Lists messages on an Amazon Q in Connect session.

Sourcemodule MessageList : sig ... end

Sourcemodule ListMessagesResponse : sig ... end

Lists messages on an Amazon Q in Connect session.

Sourcemodule ModelLifecycle : sig ... end

Sourcemodule ListModelsRequest : sig ... end

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 ModelId : sig ... end

Sourcemodule ModelDisplayName : sig ... end

Sourcemodule ModelSummary : sig ... end

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

Sourcemodule ModelSummaryList : sig ... end

Sourcemodule ListModelsResponse : sig ... end

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 : sig ... end

Lists information about quick response.

Sourcemodule QuickResponseSummary : sig ... end

The summary information about the quick response.

Sourcemodule QuickResponseSummaryList : sig ... end

Sourcemodule ListQuickResponsesResponse : sig ... end

Lists information about quick response.

Sourcemodule ListSpansRequest : sig ... end

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

Sourcemodule SpanType : sig ... end

Sourcemodule SpanStatusDescriptionString : sig ... end

Sourcemodule SpanStatus : sig ... end

Sourcemodule SpanOriginRequestIdString : sig ... end

Sourcemodule SpanToolUseValue : sig ... end

Tool invocation message content

Sourcemodule SpanCitation : sig ... end

A citation that spans a specific range of text.

Sourcemodule SpanCitationList : sig ... end

Sourcemodule SpanTextValue : sig ... end

Text message content

Sourcemodule SpanReasoningValue : sig ... end

Model reasoning and it's internal decision making process

module SpanMessageValue : sig ... end

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

module SpanMessageValueList : sig ... end

module SpanToolResultValue : sig ... end

Tool result message content

Sourcemodule SpanMessage : sig ... end

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

Sourcemodule SpanMessageList : sig ... end

Sourcemodule SpanFinishReasonList : sig ... end

Sourcemodule SpanAttributesTopPFloat : sig ... end

Sourcemodule SpanAttributesTemperatureFloat : sig ... end

Sourcemodule SpanAttributes : sig ... end

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

Sourcemodule Span : sig ... end

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

Sourcemodule SpanList : sig ... end

Sourcemodule ListSpansResponse : sig ... end

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

Sourcemodule ListTagsForResourceRequest : sig ... end

Lists the tags for the specified resource.

Sourcemodule ListTagsForResourceResponse : sig ... end

Lists the tags for the specified resource.

Sourcemodule MessageConfiguration : sig ... end

The configuration for a SendMessage request.

Sourcemodule MessageInput : sig ... end

The message input.

Sourcemodule MessageMetadata : sig ... end

Sourcemodule MessageTemplateAttributeKeyList : sig ... end

Sourcemodule MessageTemplateFilterValue : sig ... end

Sourcemodule MessageTemplateFilterValueList : sig ... end

Sourcemodule MessageTemplateFilterOperator : sig ... end

Sourcemodule MessageTemplateFilterField : sig ... end

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 : sig ... end

Sourcemodule Order : sig ... end

Sourcemodule MessageTemplateOrderField : sig ... end

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 Priority : sig ... end

Sourcemodule MessageTemplateQueryValue : sig ... end

Sourcemodule MessageTemplateQueryValueList : sig ... end

Sourcemodule MessageTemplateQueryOperator : sig ... end

Sourcemodule MessageTemplateQueryField : sig ... end

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

Sourcemodule MessageTemplateQueryFieldList : sig ... end

Sourcemodule MessageTemplateSearchExpression : sig ... end

The search expression of the message template.

Sourcemodule MessageTemplateSearchResultData : sig ... end

The result of message template search.

Sourcemodule MessageTemplateSearchResultsList : sig ... end

Sourcemodule NotifyRecommendationsReceivedErrorMessage : sig ... end

Sourcemodule NotifyRecommendationsReceivedError : sig ... end

An error occurred when creating a recommendation.

Sourcemodule NotifyRecommendationsReceivedErrorList : sig ... end

Sourcemodule NotifyRecommendationsReceivedRequest : sig ... end

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 : sig ... end

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 : sig ... end

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

Sourcemodule TargetType : sig ... end

Sourcemodule PutFeedbackRequest : sig ... end

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

Sourcemodule PutFeedbackResponse : sig ... end

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

Sourcemodule QueryTextInputData : sig ... end

Information about the text to search for.

Sourcemodule QueryInputData : sig ... end

Input information for the query.

Sourcemodule QueryConditionFieldName : sig ... end

Sourcemodule QueryConditionComparisonOperator : sig ... end

Sourcemodule QueryConditionItem : sig ... end

The condition for the query.

Sourcemodule QueryCondition : sig ... end

Information about how to query content.

Sourcemodule QueryConditionExpression : sig ... end

Sourcemodule QueryAssistantRequest : sig ... end

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 RequestTimeoutException : sig ... end

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.

Sourcemodule QueryResultType : sig ... end

Sourcemodule ResultData : sig ... end

Information about the result.

Sourcemodule QueryResultsList : sig ... end

Sourcemodule QueryAssistantResponse : sig ... end

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 : sig ... end

Sourcemodule QuickResponseFilterValueList : sig ... end

Sourcemodule QuickResponseFilterOperator : sig ... end

Sourcemodule QuickResponseFilterField : sig ... end

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 : sig ... end

Sourcemodule QuickResponseOrderField : sig ... end

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 QuickResponseQueryValue : sig ... end

Sourcemodule QuickResponseQueryValueList : sig ... end

Sourcemodule QuickResponseQueryOperator : sig ... end

Sourcemodule QuickResponseQueryField : sig ... end

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

Sourcemodule QuickResponseQueryFieldList : sig ... end

Sourcemodule QuickResponseSearchExpression : sig ... end

Information about the import job.

Sourcemodule QuickResponseSearchResultData : sig ... end

The result of quick response search.

Sourcemodule QuickResponseSearchResultsList : sig ... end

Sourcemodule RemoveAssistantAIAgentRequest : sig ... end

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

Sourcemodule RemoveAssistantAIAgentResponse : sig ... end

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

Sourcemodule RemoveKnowledgeBaseTemplateUriRequest : sig ... end

Removes a URI template from a knowledge base.

Sourcemodule RemoveKnowledgeBaseTemplateUriResponse : sig ... end

Removes a URI template from a knowledge base.

Sourcemodule RenderMessageTemplateRequest : sig ... end

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 : sig ... end

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 : sig ... end

Configuration for filtering content during retrieval operations.

module RetrievalFilterList : sig ... end

Sourcemodule RetrievalConfiguration : sig ... end

Configuration for content retrieval operations.

Sourcemodule RetrieveRequest : sig ... end

Retrieves content from knowledge sources based on a query.

Sourcemodule RetrieveResult : sig ... end

A single result from a content retrieval operation.

Sourcemodule RetrieveResultList : sig ... end

Sourcemodule RetrieveResponse : sig ... end

Retrieves content from knowledge sources based on a query.

Sourcemodule SearchExpression : sig ... end

The search expression.

Sourcemodule SearchContentRequest : sig ... end

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

Sourcemodule SearchContentResponse : sig ... end

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

Sourcemodule SearchMessageTemplatesRequest : sig ... end

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

Sourcemodule SearchMessageTemplatesResponse : sig ... end

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

Sourcemodule SearchQuickResponsesRequest : sig ... end

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

Sourcemodule SearchQuickResponsesResponse : sig ... end

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

Sourcemodule SearchSessionsRequest : sig ... end

Searches for sessions.

Sourcemodule SessionSummary : sig ... end

Summary information about the session.

Sourcemodule SessionSummaries : sig ... end

Sourcemodule SearchSessionsResponse : sig ... end

Searches for sessions.

Sourcemodule SendMessageRequestOriginRequestIdString : sig ... end

Sourcemodule SendMessageRequest : sig ... end

Submits a message to the Amazon Q in Connect session.

Sourcemodule SendMessageResponse : sig ... end

Submits a message to the Amazon Q in Connect session.

Sourcemodule SessionDataNamespace : sig ... end

Sourcemodule TimeToLive : sig ... end

Expiration time in minutes

Sourcemodule StartContentUploadRequest : sig ... end

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 : sig ... end

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 StartImportJobRequest : sig ... end

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.

Sourcemodule StartImportJobResponse : sig ... end

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.

Sourcemodule TagKeyList : sig ... end

Sourcemodule TagResourceRequest : sig ... end

Adds the specified tags to the specified resource.

Sourcemodule TooManyTagsException : sig ... end

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

Sourcemodule TagResourceResponse : sig ... end

Adds the specified tags to the specified resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes the specified tags from the specified resource.

Sourcemodule UntagResourceResponse : sig ... end

Removes the specified tags from the specified resource.

Sourcemodule UpdateAIAgentRequest : sig ... end

Updates an AI Agent.

Sourcemodule UpdateAIAgentResponse : sig ... end

Updates an AI Agent.

Sourcemodule UpdateAIGuardrailRequest : sig ... end

Updates an AI Guardrail.

Sourcemodule UpdateAIGuardrailResponse : sig ... end

Updates an AI Guardrail.

Sourcemodule UpdateAIPromptRequest : sig ... end

Updates an AI Prompt.

Sourcemodule UpdateAIPromptResponse : sig ... end

Updates an AI Prompt.

Sourcemodule UpdateAssistantAIAgentRequest : sig ... end

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

Sourcemodule UpdateAssistantAIAgentResponse : sig ... end

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

Sourcemodule UpdateContentRequest : sig ... end

Updates information about the content.

Sourcemodule UpdateContentResponse : sig ... end

Updates information about the content.

Sourcemodule UpdateKnowledgeBaseTemplateUriRequest : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

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 : sig ... end

Updates an existing Amazon Q in Connect quick response.

Sourcemodule UpdateQuickResponseResponse : sig ... end

Updates an existing Amazon Q in Connect quick response.

Sourcemodule UpdateSessionDataRequest : sig ... end

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

Sourcemodule UpdateSessionDataResponse : sig ... end

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

Sourcemodule UpdateSessionRequest : sig ... end

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.

Sourcemodule UpdateSessionResponse : sig ... end

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.