Module types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Amazon Q Connect can respond with.

Structs

• 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.

• AiAgentData

  The data for the AI Agent.

• AiAgentSummary

  The summary of the AI Agent.

• AiAgentVersionSummary

  The summary of the AI Agent version.

• AiPromptData

  The data for the AI Prompt

• AiPromptSummary

  The summary of the AI Prompt.

• AiPromptVersionSummary

  The summary of the AI Prompt version.

• AmazonConnectGuideAssociationData

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

• AnswerRecommendationAiAgentConfiguration

  The configuration for the ANSWER_RECOMMENDATION AI Agent type.

• AppIntegrationsConfiguration

  Configuration information for Amazon AppIntegrations to automatically ingest content.

• AssistantAssociationData

  Information about the assistant association.

• AssistantAssociationSummary

  Summary information about the assistant association.

• AssistantCapabilityConfiguration

  The capability configuration for an Amazon Q in Connect assistant.

• AssistantData

  The assistant data.

• AssistantIntegrationConfiguration

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

• AssistantSummary

  Summary information about the assistant.

• AssociationConfiguration

  The configuration for an Amazon Q in Connect Assistant Association.

• BedrockFoundationModelConfigurationForParsing

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

• ChunkingConfiguration

  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.

• CitationSpan

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

• ConnectConfiguration

  The configuration information of the Amazon Connect data source.

• ContentAssociationData

  Information about the content association.

• ContentAssociationSummary

  Summary information about a content association.

• ContentData

  Information about the content.

• ContentDataDetails

  Details about the content data.

• ContentReference

  Reference information about the content.

• ContentSummary

  Summary information about the content.

• DataSummary

  Summary of the data.

• Document

  The document.

• DocumentText

  The text of the document.

• ExternalSourceConfiguration

  The configuration information of the external data source.

• Filter

  A search filter.

• FixedSizeChunkingConfiguration

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

• GenerativeContentFeedbackData

  The feedback information for a generative target type.

• GenerativeDataDetails

  Details about generative data.

• GenerativeReference

  Reference information about generative content.

• GroupingConfiguration

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

• 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.

• HierarchicalChunkingLevelConfiguration

  Token settings for each layer.

• Highlight

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

• ImportJobData

  Summary information about the import job.

• ImportJobSummary

  Summary information about the import job.

• IntentDetectedDataDetails

  Details about the detected intent.

• IntentInputData

  Information about the Amazon Q intent.

• KnowledgeBaseAssociationConfigurationData

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

• KnowledgeBaseAssociationData

  Association information about the knowledge base.

• KnowledgeBaseData

  Information about the knowledge base.

• KnowledgeBaseSummary

  Summary information about the knowledge base.

• ManualSearchAiAgentConfiguration

  The configuration for the MANUAL_SEARCH AI Agent type.

• NotifyRecommendationsReceivedError

  An error occurred when creating a recommendation.

• ParsingConfiguration

  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.

• ParsingPrompt

  Instructions for interpreting the contents of a document.

• QueryConditionItem

  The condition for the query.

• QueryRecommendationTriggerData

  Data associated with the QUERY RecommendationTriggerType.

• QueryTextInputData

  Information about the text to search for.

• QuickResponseContents

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

• QuickResponseData

  Information about the quick response.

• 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

• QuickResponseOrderField

  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

• QuickResponseQueryField

  The quick response fields to query quick responses by.

  The following is the list of supported field names.

  • content

  • name

  • description

  • shortcutKey

• QuickResponseSearchExpression

  Information about the import job.

• QuickResponseSearchResultData

  The result of quick response search.

• QuickResponseSummary

  The summary information about the quick response.

• RankingData

  Details about the source content ranking data.

• RecommendationData

  Information about the recommendation.

• RecommendationTrigger

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

• RenderingConfiguration

  Information about how to render the content.

• ResultData

  Information about the result.

• RuntimeSessionData

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

• SearchExpression

  The search expression.

• SeedUrl

  A URL for crawling.

• 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.

• ServerSideEncryptionConfiguration

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

• SessionData

  Information about the session.

• SessionIntegrationConfiguration

  The configuration information for the session integration.

• SessionSummary

  Summary information about the session.

• SourceContentDataDetails

  Details about the source content data.

• TagCondition

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

• TextData

  Details about the source content text data.

• TextFullAiPromptEditTemplateConfiguration

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

• UrlConfiguration

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

• VectorIngestionConfiguration

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

• WebCrawlerConfiguration

  The configuration details for the web data source.

• WebCrawlerLimits

  The configuration of crawl limits for the web URLs.

Enums

• AiAgentAssociationConfigurationType
  When writing a match expression against AiAgentAssociationConfigurationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AiAgentConfiguration

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

• AiAgentType
  When writing a match expression against AiAgentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AiPromptApiFormat
  When writing a match expression against AiPromptApiFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AiPromptTemplateConfiguration

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

• AiPromptTemplateType
  When writing a match expression against AiPromptTemplateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AiPromptType
  When writing a match expression against AiPromptType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AssistantAssociationInputData

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

• AssistantAssociationOutputData

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

• AssistantCapabilityType
  When writing a match expression against AssistantCapabilityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AssistantStatus
  When writing a match expression against AssistantStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AssistantType
  When writing a match expression against AssistantType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AssociationConfigurationData

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

• AssociationType
  When writing a match expression against AssociationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ChunkingStrategy
  When writing a match expression against ChunkingStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Configuration

  The configuration information of the external data source.

• ContentAssociationContents

  The contents of a content association.

• ContentAssociationType
  When writing a match expression against ContentAssociationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ContentFeedbackData

  Information about the feedback.

• ContentStatus
  When writing a match expression against ContentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataDetails

  Details about the data.

• DataReference

  Reference data.

• ExternalSource
  When writing a match expression against ExternalSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• FilterField
  When writing a match expression against FilterField, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• FilterOperator
  When writing a match expression against FilterOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ImportJobStatus
  When writing a match expression against ImportJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ImportJobType
  When writing a match expression against ImportJobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseSearchType
  When writing a match expression against KnowledgeBaseSearchType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseStatus
  When writing a match expression against KnowledgeBaseStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseType
  When writing a match expression against KnowledgeBaseType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ManagedSourceConfiguration

  Source configuration for managed resources.

• OrCondition

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

• Order
  When writing a match expression against Order, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Origin
  When writing a match expression against Origin, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ParsingStrategy
  When writing a match expression against ParsingStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Priority
  When writing a match expression against Priority, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QueryCondition

  Information about how to query content.

• QueryConditionComparisonOperator
  When writing a match expression against QueryConditionComparisonOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QueryConditionFieldName
  When writing a match expression against QueryConditionFieldName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QueryInputData

  Input information for the query.

• QueryResultType
  When writing a match expression against QueryResultType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QuickResponseContentProvider

  The container quick response content.

• QuickResponseDataProvider

  The container of quick response data.

• QuickResponseFilterOperator
  When writing a match expression against QuickResponseFilterOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QuickResponseQueryOperator
  When writing a match expression against QuickResponseQueryOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• QuickResponseStatus
  When writing a match expression against QuickResponseStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecommendationSourceType
  When writing a match expression against RecommendationSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecommendationTriggerData

  A union type containing information related to the trigger.

• RecommendationTriggerType
  When writing a match expression against RecommendationTriggerType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecommendationType
  When writing a match expression against RecommendationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ReferenceType
  When writing a match expression against ReferenceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Relevance
  When writing a match expression against Relevance, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RelevanceLevel
  When writing a match expression against RelevanceLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RuntimeSessionDataValue

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

• SessionDataNamespace
  When writing a match expression against SessionDataNamespace, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SourceConfiguration

  Configuration information about the external data source.

• SourceContentType
  When writing a match expression against SourceContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Status
  When writing a match expression against Status, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SyncStatus
  When writing a match expression against SyncStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TagFilter

  An object that can be used to specify Tag conditions.

• TargetType
  When writing a match expression against TargetType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VisibilityStatus
  When writing a match expression against VisibilityStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• WebScopeType
  When writing a match expression against WebScopeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.