Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Agent
Attributes Information about an agent.
- AiAgent
Configuration Data 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.
- AiAgent
Data The data for the AI Agent.
- AiAgent
Summary The summary of the AI Agent.
- AiAgent
Version Summary The summary of the AI Agent version.
- AiGuardrail
Content Policy Config Contains details about how to handle harmful content.
- AiGuardrail
Contextual Grounding Policy Config The policy configuration details for the AI Guardrail's contextual grounding policy.
- AiGuardrail
Data The data for the AI Guardrail
- AiGuardrail
Sensitive Information Policy Config Contains details about PII entities and regular expressions to configure for the AI Guardrail.
- AiGuardrail
Summary The summary of the AI Guardrail.
- AiGuardrail
Topic Policy Config Contains details about topics that the AI Guardrail should identify and deny.
- AiGuardrail
Version Summary The summary of the AI Guardrail version.
- AiGuardrail
Word Policy Config Contains details about the word policy to configured for the AI Guardrail.
- AiPrompt
Data The data for the AI Prompt
- AiPrompt
Summary The summary of the AI Prompt.
- AiPrompt
Version Summary The summary of the AI Prompt version.
- Amazon
Connect Guide Association Data Content association data for a step-by-step guide.
- Answer
Recommendation AiAgent Configuration The configuration for the
ANSWER_RECOMMENDATION
AI Agent type.- AppIntegrations
Configuration Configuration information for Amazon AppIntegrations to automatically ingest content.
- Assistant
Association Data Information about the assistant association.
- Assistant
Association Summary Summary information about the assistant association.
- Assistant
Capability Configuration The capability configuration for an Amazon Q in Connect assistant.
- Assistant
Data The assistant data.
- Assistant
Integration Configuration The configuration information for the Amazon Q in Connect assistant integration.
- Assistant
Summary Summary information about the assistant.
- Association
Configuration The configuration for an Amazon Q in Connect Assistant Association.
- Bedrock
Foundation Model Configuration ForParsing Settings for a foundation model used to parse documents for a data source.
- Chunking
Configuration 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.
- Citation
Span Contains information about where the text with a citation begins and ends in the generated output.
- Connect
Configuration The configuration information of the Amazon Connect data source.
- Content
Association Data Information about the content association.
- Content
Association Summary Summary information about a content association.
- Content
Data Information about the content.
- Content
Data Details Details about the content data.
- Content
Reference Reference information about the content.
- Content
Summary Summary information about the content.
- Conversation
Context The conversation context to include in SendMessage.
- Conversation
State The conversation state associated to a message.
- Customer
Profile Attributes The customer profile attributes that are used with the message template.
- Data
Summary Summary of the data.
- Document
The document.
- Document
Text The text of the document.
- Email
Header The email header to include in email messages.
- Email
Message Template Content The content of the message template that applies to the email channel subtype.
- Email
Message Template Content Body The body to use in email messages.
- Extended
Message Template Data The extended data of a message template.
- External
Source Configuration The configuration information of the external data source.
- Filter
A search filter.
- Fixed
Size Chunking Configuration Configurations for when you choose fixed-size chunking. If you set the
chunkingStrategy
asNONE
, exclude this field.- Generative
Chunk Data Details Details about the generative chunk data.
- Generative
Content Feedback Data The feedback information for a generative target type.
- Generative
Data Details Details about generative data.
- Generative
Reference Reference information about generative content.
- Grouping
Configuration The configuration information of the grouping of Amazon Q in Connect users.
- Guardrail
Content Filter Config 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.
-
- Guardrail
Contextual Grounding Filter Config The filter configuration details for the AI Guardrail's contextual grounding filter.
- Guardrail
Managed Words Config The managed word list to configure for the AI Guardrail.
- Guardrail
PiiEntity Config The PII entity to configure for the AI Guardrail.
- Guardrail
Regex Config The regular expression to configure for the AI Guardrail.
- Guardrail
Topic Config Details about topics for the AI Guardrail to identify and deny.
- Guardrail
Word Config A word to configure for the AI Guardrail.
- Hierarchical
Chunking Configuration 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.
- Hierarchical
Chunking Level Configuration Token settings for each layer.
- Highlight
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
- Import
JobData Summary information about the import job.
- Import
JobSummary Summary information about the import job.
- Intent
Detected Data Details Details about the detected intent.
- Intent
Input Data Information about the Amazon Q intent.
- Knowledge
Base Association Configuration Data The data of the configuration for a
KNOWLEDGE_BASE
type Amazon Q in Connect Assistant Association.- Knowledge
Base Association Data Association information about the knowledge base.
- Knowledge
Base Data Information about the knowledge base.
- Knowledge
Base Summary Summary information about the knowledge base.
- Manual
Search AiAgent Configuration The configuration for the
MANUAL_SEARCH
AI Agent type.- Message
Configuration The configuration for a SendMessage request.
- Message
Input The message input.
- Message
Output The message output.
- Message
Template Attachment Information about the message template attachment.
- Message
Template Attributes The attributes that are used with the message template.
- Message
Template Data The data of a message template.
- Message
Template Filter Field 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
-
- Message
Template Order Field 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
-
- Message
Template Query Field The message template fields to query message templates by. The following is the list of supported field names:
-
name
-
description
-
- Message
Template Search Expression The search expression of the message template.
- Message
Template Search Result Data The result of message template search.
- Message
Template Summary The summary of the message template.
- Message
Template Version Summary The summary of the message template version.
- Notify
Recommendations Received Error An error occurred when creating a recommendation.
- Parsing
Configuration 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.
- Parsing
Prompt Instructions for interpreting the contents of a document.
- Query
Condition Item The condition for the query.
- Query
Recommendation Trigger Data Data associated with the QUERY RecommendationTriggerType.
- Query
Text Input Data Information about the text to search for.
- Quick
Response Contents The content of the quick response stored in different media types.
- Quick
Response Data Information about the quick response.
- Quick
Response Filter Field 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
-
- Quick
Response Order Field 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
-
- Quick
Response Query Field The quick response fields to query quick responses by.
The following is the list of supported field names.
-
content
-
name
-
description
-
shortcutKey
-
- Quick
Response Search Expression Information about the import job.
- Quick
Response Search Result Data The result of quick response search.
- Quick
Response Summary The summary information about the quick response.
- Ranking
Data Details about the source content ranking data.
- Recommendation
Data Information about the recommendation.
- Recommendation
Trigger A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in
recommendationIds
by a single RecommendationTrigger.- Rendering
Configuration Information about how to render the content.
- Result
Data Information about the result.
- Runtime
Session Data The list of key-value pairs that are stored on the session.
- Search
Expression The search expression.
- SeedUrl
A URL for crawling.
- Self
Service AiAgent Configuration The configuration for AI Agents of type SELF_SERVICE.
- Self
Service Conversation History The conversation history data to included in conversation context data before the Amazon Q in Connect session.
- Semantic
Chunking Configuration 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.
- Server
Side Encryption Configuration The configuration information for the customer managed key used for encryption.
- Session
Data Information about the session.
- Session
Integration Configuration The configuration information for the session integration.
- Session
Summary Summary information about the session.
- SmsMessage
Template Content The content of the message template that applies to the SMS channel subtype.
- SmsMessage
Template Content Body The body to use in SMS messages.
- Source
Content Data Details Details about the source content data.
- System
Attributes The system attributes that are used with the message template.
- System
Endpoint Attributes The system endpoint attributes that are used with the message template.
- TagCondition
A leaf node condition which can be used to specify a tag condition.
- Text
Data Details about the source content text data.
- Text
Full AiPrompt Edit Template Configuration The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
- Text
Message The message data in text type.
- UrlConfiguration
The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
- Vector
Ingestion Configuration Contains details about how to ingest the documents in a data source.
- WebCrawler
Configuration The configuration details for the web data source.
- WebCrawler
Limits The configuration of crawl limits for the web URLs.
Enums§
- AiAgent
Association Configuration Type - 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. - AiAgent
Configuration A typed union that specifies the configuration based on the type of AI Agent.
- AiAgent
Type - 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. - AiPrompt
ApiFormat - 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. - AiPrompt
Template Configuration A typed union that specifies the configuration for a prompt template based on its type.
- AiPrompt
Template Type - 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. - AiPrompt
Type - 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. - Assistant
Association Input Data The data that is input into Amazon Q in Connect as a result of the assistant association.
- Assistant
Association Output Data The data that is output as a result of the assistant association.
- Assistant
Capability Type - 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. - Assistant
Status - 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. - Assistant
Type - 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. - Association
Configuration Data A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
- Association
Type - 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. - Channel
Subtype - When writing a match expression against
ChannelSubtype
, 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. - Chunking
Strategy - 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.
- Content
Association Contents The contents of a content association.
- Content
Association Type - 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. - Content
Disposition - When writing a match expression against
ContentDisposition
, 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. - Content
Feedback Data Information about the feedback.
- Content
Status - 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. - Conversation
Status - When writing a match expression against
ConversationStatus
, 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. - Conversation
Status Reason - When writing a match expression against
ConversationStatusReason
, 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. - Data
Details Details about the data.
- Data
Reference Reference data.
- External
Source - 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. - Filter
Field - 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. - Filter
Operator - 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. - Guardrail
Content Filter Type - When writing a match expression against
GuardrailContentFilterType
, 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. - Guardrail
Contextual Grounding Filter Type - When writing a match expression against
GuardrailContextualGroundingFilterType
, 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. - Guardrail
Filter Strength - When writing a match expression against
GuardrailFilterStrength
, 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. - Guardrail
Managed Words Type - When writing a match expression against
GuardrailManagedWordsType
, 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. - Guardrail
PiiEntity Type - When writing a match expression against
GuardrailPiiEntityType
, 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. - Guardrail
Sensitive Information Action - When writing a match expression against
GuardrailSensitiveInformationAction
, 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. - Guardrail
Topic Type - When writing a match expression against
GuardrailTopicType
, 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. - Import
JobStatus - 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. - Import
JobType - 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. - Knowledge
Base Search Type - 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. - Knowledge
Base Status - 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. - Knowledge
Base Type - 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. - Managed
Source Configuration Source configuration for managed resources.
- Message
Data The message data.
- Message
Template Attribute Type - When writing a match expression against
MessageTemplateAttributeType
, 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. - Message
Template Body Content Provider The container of the message template body.
- Message
Template Content Provider The container of message template content.
- Message
Template Filter Operator - When writing a match expression against
MessageTemplateFilterOperator
, 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. - Message
Template Query Operator - When writing a match expression against
MessageTemplateQueryOperator
, 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. - Message
Type - When writing a match expression against
MessageType
, 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. - 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. - Parsing
Strategy - 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. - Participant
- When writing a match expression against
Participant
, 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. - Query
Condition Information about how to query content.
- Query
Condition Comparison Operator - 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. - Query
Condition Field Name - 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. - Query
Input Data Input information for the query.
- Query
Result Type - 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. - Quick
Response Content Provider The container quick response content.
- Quick
Response Data Provider The container of quick response data.
- Quick
Response Filter Operator - 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. - Quick
Response Query Operator - 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. - Quick
Response Status - 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. - Recommendation
Source Type - 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. - Recommendation
Trigger Data A union type containing information related to the trigger.
- Recommendation
Trigger Type - 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. - Recommendation
Type - 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. - Reference
Type - 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. - Relevance
Level - 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. - Runtime
Session Data Value A union type that specifies the data stored on the session.
- Session
Data Namespace - 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. - Source
Configuration Configuration information about the external data source.
- Source
Content Type - 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. - Sync
Status - 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.
- Target
Type - 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. - Visibility
Status - 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. - WebScope
Type - 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.