Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
", "operations": { "CreateAIAgent": "Creates an Amazon Q in Connect AI Agent.
", "CreateAIAgentVersion": "Creates and Amazon Q in Connect AI Agent version.
", "CreateAIPrompt": "Creates an Amazon Q in Connect AI Prompt.
", "CreateAIPromptVersion": "Creates an Amazon Q in Connect AI Prompt version.
", "CreateAssistant": "Creates an Amazon Q in Connect assistant.
", "CreateAssistantAssociation": "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.
", "CreateContent": "Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
", "CreateContentAssociation": "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.
", "CreateKnowledgeBase": "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.
Creates an Amazon Q in Connect quick response.
", "CreateSession": "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.
", "DeleteAIAgent": "Deletes an Amazon Q in Connect AI Agent.
", "DeleteAIAgentVersion": "Deletes an Amazon Q in Connect AI Agent Version.
", "DeleteAIPrompt": "Deletes an Amazon Q in Connect AI Prompt.
", "DeleteAIPromptVersion": "Delete and Amazon Q in Connect AI Prompt version.
", "DeleteAssistant": "Deletes an assistant.
", "DeleteAssistantAssociation": "Deletes an assistant association.
", "DeleteContent": "Deletes the content.
", "DeleteContentAssociation": "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.
", "DeleteImportJob": "Deletes the quick response import job.
", "DeleteKnowledgeBase": "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.
Deletes a quick response.
", "GetAIAgent": "Gets an Amazon Q in Connect AI Agent.
", "GetAIPrompt": "Gets and Amazon Q in Connect AI Prompt.
", "GetAssistant": "Retrieves information about an assistant.
", "GetAssistantAssociation": "Retrieves information about an assistant association.
", "GetContent": "Retrieves content, including a pre-signed URL to download the content.
", "GetContentAssociation": "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.
", "GetContentSummary": "Retrieves summary information about the content.
", "GetImportJob": "Retrieves the started import job.
", "GetKnowledgeBase": "Retrieves information about the knowledge base.
", "GetQuickResponse": "Retrieves the quick response.
", "GetRecommendations": "This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Retrieves information for a specified session.
", "ListAIAgentVersions": "List AI Agent versions.
", "ListAIAgents": "Lists AI Agents.
", "ListAIPromptVersions": "Lists AI Prompt versions.
", "ListAIPrompts": "Lists the AI Prompts available on the Amazon Q in Connect assistant.
", "ListAssistantAssociations": "Lists information about assistant associations.
", "ListAssistants": "Lists information about assistants.
", "ListContentAssociations": "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.
", "ListContents": "Lists the content.
", "ListImportJobs": "Lists information about import jobs.
", "ListKnowledgeBases": "Lists the knowledge bases.
", "ListQuickResponses": "Lists information about quick response.
", "ListTagsForResource": "Lists the tags for the specified resource.
", "NotifyRecommendationsReceived": "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.
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
", "QueryAssistant": "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.
", "RemoveAssistantAIAgent": "Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
", "RemoveKnowledgeBaseTemplateUri": "Removes a URI template from a knowledge base.
", "SearchContent": "Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
", "SearchQuickResponses": "Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
", "SearchSessions": "Searches for sessions.
", "StartContentUpload": "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.
", "StartImportJob": "Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
Adds the specified tags to the specified resource.
", "UntagResource": "Removes the specified tags from the specified resource.
", "UpdateAIAgent": "Updates an AI Agent.
", "UpdateAIPrompt": "Updates an AI Prompt.
", "UpdateAssistantAIAgent": "Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
", "UpdateContent": "Updates information about the content.
", "UpdateKnowledgeBaseTemplateUri": "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.
Updates an existing Amazon Q in Connect quick response.
", "UpdateSession": "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.
", "UpdateSessionData": "Updates the data stored on an Amazon Q in Connect Session.
" }, "shapes": { "AIAgentAssociationConfigurationType": { "base": null, "refs": { "AssociationConfiguration$associationType": "The type of the association for this Association Configuration.
" } }, "AIAgentConfiguration": { "base": "A typed union that specifies the configuration based on the type of AI Agent.
", "refs": { "AIAgentData$configuration": "Configuration for the AI Agent.
", "AIAgentSummary$configuration": "The configuration for the AI Agent.
", "CreateAIAgentRequest$configuration": "The configuration of the AI Agent.
", "UpdateAIAgentRequest$configuration": "The configuration of the Amazon Q in Connect AI Agent.
" } }, "AIAgentConfigurationData": { "base": "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.
", "refs": { "AIAgentConfigurationMap$value": null, "UpdateAssistantAIAgentRequest$configuration": "The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" } }, "AIAgentConfigurationMap": { "base": null, "refs": { "AssistantData$aiAgentConfiguration": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
", "AssistantSummary$aiAgentConfiguration": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
", "CreateSessionRequest$aiAgentConfiguration": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
", "SessionData$aiAgentConfiguration": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
", "UpdateSessionRequest$aiAgentConfiguration": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
" } }, "AIAgentData": { "base": "The data for the AI Agent.
", "refs": { "CreateAIAgentResponse$aiAgent": "The data of the created AI Agent.
", "CreateAIAgentVersionResponse$aiAgent": "The data of the AI Agent version.
", "GetAIAgentResponse$aiAgent": "The data of the AI Agent.
", "UpdateAIAgentResponse$aiAgent": "The data of the updated Amazon Q in Connect AI Agent.
" } }, "AIAgentSummary": { "base": "The summary of the AI Agent.
", "refs": { "AIAgentSummaryList$member": null, "AIAgentVersionSummary$aiAgentSummary": "The data for the summary of the AI Agent version.
" } }, "AIAgentSummaryList": { "base": null, "refs": { "ListAIAgentsResponse$aiAgentSummaries": "The summaries of AI Agents.
" } }, "AIAgentType": { "base": null, "refs": { "AIAgentConfigurationMap$key": null, "AIAgentData$type": "The type of the AI Agent.
", "AIAgentSummary$type": "The type of the AI Agent.
", "CreateAIAgentRequest$type": "The type of the AI Agent.
", "RemoveAssistantAIAgentRequest$aiAgentType": "The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.
", "UpdateAssistantAIAgentRequest$aiAgentType": "The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" } }, "AIAgentVersionSummariesList": { "base": null, "refs": { "ListAIAgentVersionsResponse$aiAgentVersionSummaries": "The summaries of AI Agent versions.
" } }, "AIAgentVersionSummary": { "base": "The summary of the AI Agent version.
", "refs": { "AIAgentVersionSummariesList$member": null } }, "AIPromptAPIFormat": { "base": null, "refs": { "AIPromptData$apiFormat": "The API format used for this AI Prompt.
", "AIPromptSummary$apiFormat": "The API format used for this AI Prompt.
", "CreateAIPromptRequest$apiFormat": "The API Format of the AI Prompt.
" } }, "AIPromptData": { "base": "The data for the AI Prompt
", "refs": { "CreateAIPromptResponse$aiPrompt": "The data of the AI Prompt.
", "CreateAIPromptVersionResponse$aiPrompt": "The data of the AI Prompt version.
", "GetAIPromptResponse$aiPrompt": "The data of the AI Prompt.
", "UpdateAIPromptResponse$aiPrompt": "The data of the updated Amazon Q in Connect AI Prompt.
" } }, "AIPromptModelIdentifier": { "base": null, "refs": { "AIPromptData$modelId": "The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1
The summary of the AI Prompt.
", "refs": { "AIPromptSummaryList$member": null, "AIPromptVersionSummary$aiPromptSummary": "The date for the summary of the AI Prompt version.
" } }, "AIPromptSummaryList": { "base": null, "refs": { "ListAIPromptsResponse$aiPromptSummaries": "The summaries of the AI Prompts.
" } }, "AIPromptTemplateConfiguration": { "base": "A typed union that specifies the configuration for a prompt template based on its type.
", "refs": { "AIPromptData$templateConfiguration": "The configuration of the prompt template for this AI Prompt.
", "CreateAIPromptRequest$templateConfiguration": "The configuration of the prompt template for this AI Prompt.
", "UpdateAIPromptRequest$templateConfiguration": "The configuration of the prompt template for this AI Prompt.
" } }, "AIPromptTemplateType": { "base": null, "refs": { "AIPromptData$templateType": "The type of the prompt template for this AI Prompt.
", "AIPromptSummary$templateType": "The type of the prompt template for this AI Prompt.
", "CreateAIPromptRequest$templateType": "The type of the prompt template for this AI Prompt.
" } }, "AIPromptType": { "base": null, "refs": { "AIPromptData$type": "The type of this AI Prompt.
", "AIPromptSummary$type": "The type of this AI Prompt.
", "CreateAIPromptRequest$type": "The type of this AI Prompt.
" } }, "AIPromptVersionSummariesList": { "base": null, "refs": { "ListAIPromptVersionsResponse$aiPromptVersionSummaries": "The summaries of the AI Prompt versions.
" } }, "AIPromptVersionSummary": { "base": "The summary of the AI Prompt version.
", "refs": { "AIPromptVersionSummariesList$member": null } }, "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AmazonConnectGuideAssociationData": { "base": "Content association data for a step-by-step guide.
", "refs": { "ContentAssociationContents$amazonConnectGuideAssociation": "The data of the step-by-step guide association.
" } }, "AndConditions": { "base": null, "refs": { "OrCondition$andConditions": "A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an AND condition.
The configuration for the ANSWER_RECOMMENDATION AI Agent type.
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
Configuration information for Amazon AppIntegrations to automatically ingest content.
", "refs": { "SourceConfiguration$appIntegrations": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" } }, "Arn": { "base": null, "refs": { "AIAgentData$aiAgentArn": "The Amazon Resource Name (ARN) of the AI agent.
", "AIAgentData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIAgentSummary$aiAgentArn": "The Amazon Resource Name (ARN) of the AI agent.
", "AIAgentSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIPromptData$aiPromptArn": "The Amazon Resource Name (ARN) of the AI Prompt.
", "AIPromptData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIPromptSummary$aiPromptArn": "The Amazon Resource Name (ARN) of the AI Prompt.
", "AIPromptSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AssistantAssociationData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AssistantAssociationData$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", "AssistantAssociationSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AssistantAssociationSummary$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", "AssistantData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AssistantSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "ContentAssociationData$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentAssociationData$contentAssociationArn": "The Amazon Resource Name (ARN) of the content association.
", "ContentAssociationData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentAssociationSummary$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentAssociationSummary$contentAssociationArn": "The Amazon Resource Name (ARN) of the content association.
", "ContentAssociationSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentData$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentReference$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentReference$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentSummary$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ImportJobData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ImportJobSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "KnowledgeBaseAssociationData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "KnowledgeBaseData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "KnowledgeBaseSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "QuickResponseData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseData$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "QuickResponseSearchResultData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseSearchResultData$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "QuickResponseSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseSummary$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "SessionData$sessionArn": "The Amazon Resource Name (ARN) of the session.
", "SessionSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "SessionSummary$sessionArn": "The Amazon Resource Name (ARN) of the session.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "UpdateSessionDataResponse$sessionArn": "The Amazon Resource Name (ARN) of the session.
" } }, "AssistantAssociationData": { "base": "Information about the assistant association.
", "refs": { "CreateAssistantAssociationResponse$assistantAssociation": "The assistant association.
", "GetAssistantAssociationResponse$assistantAssociation": "The assistant association.
" } }, "AssistantAssociationInputData": { "base": "The data that is input into Amazon Q in Connect as a result of the assistant association.
", "refs": { "CreateAssistantAssociationRequest$association": "The identifier of the associated resource.
" } }, "AssistantAssociationOutputData": { "base": "The data that is output as a result of the assistant association.
", "refs": { "AssistantAssociationData$associationData": "A union type that currently has a single argument, the knowledge base ID.
", "AssistantAssociationSummary$associationData": "The association data.
" } }, "AssistantAssociationSummary": { "base": "Summary information about the assistant association.
", "refs": { "AssistantAssociationSummaryList$member": null } }, "AssistantAssociationSummaryList": { "base": null, "refs": { "ListAssistantAssociationsResponse$assistantAssociationSummaries": "Summary information about assistant associations.
" } }, "AssistantCapabilityConfiguration": { "base": "The capability configuration for an Amazon Q in Connect assistant.
", "refs": { "AssistantData$capabilityConfiguration": "The configuration information for the Amazon Q in Connect assistant capability.
", "AssistantSummary$capabilityConfiguration": "The configuration information for the Amazon Q in Connect assistant capability.
" } }, "AssistantCapabilityType": { "base": null, "refs": { "AssistantCapabilityConfiguration$type": "The type of Amazon Q in Connect assistant capability.
" } }, "AssistantData": { "base": "The assistant data.
", "refs": { "CreateAssistantResponse$assistant": "Information about the assistant.
", "GetAssistantResponse$assistant": "Information about the assistant.
", "UpdateAssistantAIAgentResponse$assistant": null } }, "AssistantIntegrationConfiguration": { "base": "The configuration information for the Amazon Q in Connect assistant integration.
", "refs": { "AssistantData$integrationConfiguration": "The configuration information for the Amazon Q in Connect assistant integration.
", "AssistantSummary$integrationConfiguration": "The configuration information for the Amazon Q in Connect assistant integration.
" } }, "AssistantList": { "base": null, "refs": { "ListAssistantsResponse$assistantSummaries": "Information about the assistants.
" } }, "AssistantStatus": { "base": null, "refs": { "AssistantData$status": "The status of the assistant.
", "AssistantSummary$status": "The status of the assistant.
" } }, "AssistantSummary": { "base": "Summary information about the assistant.
", "refs": { "AssistantList$member": null } }, "AssistantType": { "base": null, "refs": { "AssistantData$type": "The type of assistant.
", "AssistantSummary$type": "The type of the assistant.
", "CreateAssistantRequest$type": "The type of assistant.
" } }, "AssociationConfiguration": { "base": "The configuration for an Amazon Q in Connect Assistant Association.
", "refs": { "AssociationConfigurationList$member": null } }, "AssociationConfigurationData": { "base": "A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
", "refs": { "AssociationConfiguration$associationConfigurationData": "The data of the configuration for an Amazon Q in Connect Assistant Association.
" } }, "AssociationConfigurationList": { "base": null, "refs": { "AnswerRecommendationAIAgentConfiguration$associationConfigurations": "The association configurations for overriding behavior on this AI Agent.
", "ManualSearchAIAgentConfiguration$associationConfigurations": "The association configurations for overriding behavior on this AI Agent.
" } }, "AssociationType": { "base": null, "refs": { "AssistantAssociationData$associationType": "The type of association.
", "AssistantAssociationSummary$associationType": "The type of association.
", "CreateAssistantAssociationRequest$associationType": "The type of association.
" } }, "BedrockFoundationModelConfigurationForParsing": { "base": "Settings for a foundation model used to parse documents for a data source.
", "refs": { "ParsingConfiguration$bedrockFoundationModelConfiguration": "Settings for a foundation model used to parse documents for a data source.
" } }, "BedrockModelArnForParsing": { "base": null, "refs": { "BedrockFoundationModelConfigurationForParsing$modelArn": "The ARN of the foundation model.
" } }, "Boolean": { "base": null, "refs": { "CreateQuickResponseRequest$isActive": "Whether the quick response is active.
", "QuickResponseData$isActive": "Whether the quick response is active.
", "QuickResponseFilterField$includeNoExistence": "Whether to treat null value as a match for the attribute field.
", "QuickResponseQueryField$allowFuzziness": "Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
", "QuickResponseSearchResultData$isActive": "Whether the quick response is active.
", "QuickResponseSummary$isActive": "Whether the quick response is active.
", "UpdateContentRequest$removeOverrideLinkOutUri": "Unset the existing overrideLinkOutUri if it exists.
Whether the quick response is active.
", "UpdateQuickResponseRequest$removeDescription": "Whether to remove the description from the quick response.
", "UpdateQuickResponseRequest$removeGroupingConfiguration": "Whether to remove the grouping configuration of the quick response.
", "UpdateQuickResponseRequest$removeShortcutKey": "Whether to remove the shortcut key of the quick response.
" } }, "Channel": { "base": null, "refs": { "Channels$member": null } }, "Channels": { "base": null, "refs": { "CreateQuickResponseRequest$channels": "The Amazon Connect channels this quick response applies to.
", "QuickResponseData$channels": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
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.
", "refs": { "VectorIngestionConfiguration$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.
" } }, "ChunkingStrategy": { "base": null, "refs": { "ChunkingConfiguration$chunkingStrategy": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
Contains information about where the text with a citation begins and ends in the generated output.
", "refs": { "SourceContentDataDetails$citationSpan": "Contains information about where the text with a citation begins and ends in the generated output.
" } }, "CitationSpanOffset": { "base": null, "refs": { "CitationSpan$beginOffsetInclusive": "Where the text with a citation starts in the generated output.
", "CitationSpan$endOffsetExclusive": "Where the text with a citation ends in the generated output.
" } }, "ClientToken": { "base": null, "refs": { "CreateAIAgentRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateAIAgentVersionRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateAIPromptRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateAIPromptVersionRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateAssistantAssociationRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateAssistantRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateContentAssociationRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateSessionRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateAIAgentRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "UpdateAIPromptRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" } }, "Configuration": { "base": "The configuration information of the external data source.
", "refs": { "ExternalSourceConfiguration$configuration": "The configuration information of the external data source.
" } }, "ConflictException": { "base": "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.
The configuration information of the Amazon Connect data source.
", "refs": { "Configuration$connectConfiguration": "The configuration information of the Amazon Connect data source.
" } }, "ContactAttributeKey": { "base": null, "refs": { "ContactAttributeKeys$member": null, "ContactAttributes$key": null } }, "ContactAttributeKeys": { "base": null, "refs": { "QuickResponseSearchResultData$attributesInterpolated": "The user defined contact attributes that are resolved when the search result is returned.
", "QuickResponseSearchResultData$attributesNotInterpolated": "The user defined contact attributes that are not resolved when the search result is returned.
" } }, "ContactAttributeValue": { "base": null, "refs": { "ContactAttributes$value": null } }, "ContactAttributes": { "base": null, "refs": { "SearchQuickResponsesRequest$attributes": "The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
" } }, "ContentAssociationContents": { "base": "The contents of a content association.
", "refs": { "ContentAssociationData$associationData": "The content association.
", "ContentAssociationSummary$associationData": "The content association.
", "CreateContentAssociationRequest$association": "The identifier of the associated resource.
" } }, "ContentAssociationData": { "base": "Information about the content association.
", "refs": { "CreateContentAssociationResponse$contentAssociation": "The association between Amazon Q in Connect content and another resource.
", "GetContentAssociationResponse$contentAssociation": "The association between Amazon Q in Connect content and another resource.
" } }, "ContentAssociationSummary": { "base": "Summary information about a content association.
", "refs": { "ContentAssociationSummaryList$member": null } }, "ContentAssociationSummaryList": { "base": null, "refs": { "ListContentAssociationsResponse$contentAssociationSummaries": "Summary information about content associations.
" } }, "ContentAssociationType": { "base": null, "refs": { "ContentAssociationData$associationType": "The type of association.
", "ContentAssociationSummary$associationType": "The type of association.
", "CreateContentAssociationRequest$associationType": "The type of association.
" } }, "ContentData": { "base": "Information about the content.
", "refs": { "CreateContentResponse$content": "The content.
", "GetContentResponse$content": "The content.
", "UpdateContentResponse$content": "The content.
" } }, "ContentDataDetails": { "base": "Details about the content data.
", "refs": { "DataDetails$contentData": "Details about the content data.
" } }, "ContentFeedbackData": { "base": "Information about the feedback.
", "refs": { "PutFeedbackRequest$contentFeedback": "Information about the feedback provided.
", "PutFeedbackResponse$contentFeedback": "Information about the feedback provided.
" } }, "ContentMetadata": { "base": null, "refs": { "ContentData$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
", "ContentSummary$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
", "CreateContentRequest$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
", "ImportJobData$metadata": "The metadata fields of the imported Amazon Q in Connect resources.
", "ImportJobSummary$metadata": "The metadata fields of the imported Amazon Q in Connect resources.
", "StartImportJobRequest$metadata": "The metadata fields of the imported Amazon Q in Connect resources.
", "UpdateContentRequest$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
" } }, "ContentReference": { "base": "Reference information about the content.
", "refs": { "DataReference$contentReference": null, "Document$contentReference": "A reference to the content resource.
" } }, "ContentStatus": { "base": null, "refs": { "ContentData$status": "The status of the content.
", "ContentSummary$status": "The status of the content.
" } }, "ContentSummary": { "base": "Summary information about the content.
", "refs": { "ContentSummaryList$member": null, "GetContentSummaryResponse$contentSummary": "The content summary.
" } }, "ContentSummaryList": { "base": null, "refs": { "ListContentsResponse$contentSummaries": "Information about the content.
", "SearchContentResponse$contentSummaries": "Summary information about the content.
" } }, "ContentTitle": { "base": null, "refs": { "ContentData$title": "The title of the content.
", "ContentSummary$title": "The title of the content.
", "CreateContentRequest$title": "The title of the content. If not set, the title is equal to the name.
", "UpdateContentRequest$title": "The title of the content.
" } }, "ContentType": { "base": null, "refs": { "ContentData$contentType": "The media type of the content.
", "ContentSummary$contentType": "The media type of the content.
", "StartContentUploadRequest$contentType": "The type of content to upload.
" } }, "CreateAIAgentRequest": { "base": null, "refs": { } }, "CreateAIAgentResponse": { "base": null, "refs": { } }, "CreateAIAgentVersionRequest": { "base": null, "refs": { } }, "CreateAIAgentVersionResponse": { "base": null, "refs": { } }, "CreateAIPromptRequest": { "base": null, "refs": { } }, "CreateAIPromptResponse": { "base": null, "refs": { } }, "CreateAIPromptVersionRequest": { "base": null, "refs": { } }, "CreateAIPromptVersionResponse": { "base": null, "refs": { } }, "CreateAssistantAssociationRequest": { "base": null, "refs": { } }, "CreateAssistantAssociationResponse": { "base": null, "refs": { } }, "CreateAssistantRequest": { "base": null, "refs": { } }, "CreateAssistantResponse": { "base": null, "refs": { } }, "CreateContentAssociationRequest": { "base": null, "refs": { } }, "CreateContentAssociationResponse": { "base": null, "refs": { } }, "CreateContentRequest": { "base": null, "refs": { } }, "CreateContentResponse": { "base": null, "refs": { } }, "CreateKnowledgeBaseRequest": { "base": null, "refs": { } }, "CreateKnowledgeBaseResponse": { "base": null, "refs": { } }, "CreateQuickResponseRequest": { "base": null, "refs": { } }, "CreateQuickResponseResponse": { "base": null, "refs": { } }, "CreateSessionRequest": { "base": null, "refs": { } }, "CreateSessionResponse": { "base": null, "refs": { } }, "DataDetails": { "base": "Details about the data.
", "refs": { "DataSummary$details": "Details about the data.
" } }, "DataReference": { "base": "Reference data.
", "refs": { "DataSummary$reference": "Reference information about the content.
" } }, "DataSummary": { "base": "Summary of the data.
", "refs": { "DataSummaryList$member": null, "RecommendationData$data": "Summary of the recommended content.
", "ResultData$data": "Summary of the recommended content.
" } }, "DataSummaryList": { "base": null, "refs": { "GenerativeDataDetails$references": "The references used to generative the LLM response.
" } }, "DeleteAIAgentRequest": { "base": null, "refs": { } }, "DeleteAIAgentResponse": { "base": null, "refs": { } }, "DeleteAIAgentVersionRequest": { "base": null, "refs": { } }, "DeleteAIAgentVersionResponse": { "base": null, "refs": { } }, "DeleteAIPromptRequest": { "base": null, "refs": { } }, "DeleteAIPromptResponse": { "base": null, "refs": { } }, "DeleteAIPromptVersionRequest": { "base": null, "refs": { } }, "DeleteAIPromptVersionResponse": { "base": null, "refs": { } }, "DeleteAssistantAssociationRequest": { "base": null, "refs": { } }, "DeleteAssistantAssociationResponse": { "base": null, "refs": { } }, "DeleteAssistantRequest": { "base": null, "refs": { } }, "DeleteAssistantResponse": { "base": null, "refs": { } }, "DeleteContentAssociationRequest": { "base": null, "refs": { } }, "DeleteContentAssociationResponse": { "base": null, "refs": { } }, "DeleteContentRequest": { "base": null, "refs": { } }, "DeleteContentResponse": { "base": null, "refs": { } }, "DeleteImportJobRequest": { "base": null, "refs": { } }, "DeleteImportJobResponse": { "base": null, "refs": { } }, "DeleteKnowledgeBaseRequest": { "base": null, "refs": { } }, "DeleteKnowledgeBaseResponse": { "base": null, "refs": { } }, "DeleteQuickResponseRequest": { "base": null, "refs": { } }, "DeleteQuickResponseResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "AIAgentData$description": "The description of the AI Agent.
", "AIAgentSummary$description": "The description of the AI Agent.
", "AIPromptData$description": "The description of the AI Prompt.
", "AIPromptSummary$description": "The description of the AI Prompt.
", "AssistantData$description": "The description.
", "AssistantSummary$description": "The description of the assistant.
", "CreateAIAgentRequest$description": "The description of the AI Agent.
", "CreateAIPromptRequest$description": "The description of the AI Prompt.
", "CreateAssistantRequest$description": "The description of the assistant.
", "CreateKnowledgeBaseRequest$description": "The description.
", "CreateSessionRequest$description": "The description.
", "KnowledgeBaseData$description": "The description.
", "KnowledgeBaseSummary$description": "The description of the knowledge base.
", "SessionData$description": "The description of the session.
", "UpdateAIAgentRequest$description": "The description of the Amazon Q in Connect AI Agent.
", "UpdateAIPromptRequest$description": "The description of the Amazon Q in Connect AI Prompt.
", "UpdateSessionRequest$description": "The description.
" } }, "Document": { "base": "The document.
", "refs": { "RecommendationData$document": "The recommended document.
", "ResultData$document": "The document.
" } }, "DocumentText": { "base": "The text of the document.
", "refs": { "Document$excerpt": "The excerpt from the document.
", "Document$title": "The title of the document.
", "TextData$excerpt": null, "TextData$title": null } }, "ExternalSource": { "base": null, "refs": { "ExternalSourceConfiguration$source": "The type of the external data source.
" } }, "ExternalSourceConfiguration": { "base": "The configuration information of the external data source.
", "refs": { "ImportJobData$externalSourceConfiguration": null, "ImportJobSummary$externalSourceConfiguration": "The configuration information of the external source that the resource data are imported from.
", "StartImportJobRequest$externalSourceConfiguration": "The configuration information of the external source that the resource data are imported from.
" } }, "FailureReason": { "base": null, "refs": { "KnowledgeBaseData$ingestionFailureReasons": "List of failure reasons on ingestion per file.
" } }, "Filter": { "base": "A search filter.
", "refs": { "FilterList$member": null } }, "FilterField": { "base": null, "refs": { "Filter$field": "The field on which to filter.
" } }, "FilterList": { "base": null, "refs": { "SearchExpression$filters": "The search expression filters.
" } }, "FilterOperator": { "base": null, "refs": { "Filter$operator": "The operator to use for comparing the field’s value with the provided value.
" } }, "FixedSizeChunkingConfiguration": { "base": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The maximum number of tokens to include in a chunk.
" } }, "FixedSizeChunkingConfigurationOverlapPercentageInteger": { "base": null, "refs": { "FixedSizeChunkingConfiguration$overlapPercentage": "The percentage of overlap between adjacent chunks of a data source.
" } }, "GenerativeContentFeedbackData": { "base": "The feedback information for a generative target type.
", "refs": { "ContentFeedbackData$generativeContentFeedbackData": "Information about the feedback for a generative target type.
" } }, "GenerativeDataDetails": { "base": "Details about generative data.
", "refs": { "DataDetails$generativeData": "Details about the generative data.
" } }, "GenerativeReference": { "base": "Reference information about generative content.
", "refs": { "DataReference$generativeReference": "Reference information about the generative content.
" } }, "GenericArn": { "base": null, "refs": { "AmazonConnectGuideAssociationData$flowId": "The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
", "AppIntegrationsConfiguration$appIntegrationArn": "The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
", "QuickResponseData$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the quick response data.
", "QuickResponseSearchResultData$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
", "QuickResponseSummary$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the quick response data.
", "SessionIntegrationConfiguration$topicIntegrationArn": "The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } }, "GetAIAgentRequest": { "base": null, "refs": { } }, "GetAIAgentResponse": { "base": null, "refs": { } }, "GetAIPromptRequest": { "base": null, "refs": { } }, "GetAIPromptResponse": { "base": null, "refs": { } }, "GetAssistantAssociationRequest": { "base": null, "refs": { } }, "GetAssistantAssociationResponse": { "base": null, "refs": { } }, "GetAssistantRequest": { "base": null, "refs": { } }, "GetAssistantResponse": { "base": null, "refs": { } }, "GetContentAssociationRequest": { "base": null, "refs": { } }, "GetContentAssociationResponse": { "base": null, "refs": { } }, "GetContentRequest": { "base": null, "refs": { } }, "GetContentResponse": { "base": null, "refs": { } }, "GetContentSummaryRequest": { "base": null, "refs": { } }, "GetContentSummaryResponse": { "base": null, "refs": { } }, "GetImportJobRequest": { "base": null, "refs": { } }, "GetImportJobResponse": { "base": null, "refs": { } }, "GetKnowledgeBaseRequest": { "base": null, "refs": { } }, "GetKnowledgeBaseResponse": { "base": null, "refs": { } }, "GetQuickResponseRequest": { "base": null, "refs": { } }, "GetQuickResponseResponse": { "base": null, "refs": { } }, "GetRecommendationsRequest": { "base": null, "refs": { } }, "GetRecommendationsResponse": { "base": null, "refs": { } }, "GetSessionRequest": { "base": null, "refs": { } }, "GetSessionResponse": { "base": null, "refs": { } }, "GroupingConfiguration": { "base": "The configuration information of the grouping of Amazon Q in Connect users.
", "refs": { "CreateQuickResponseRequest$groupingConfiguration": "The configuration information of the user groups that the quick response is accessible to.
", "QuickResponseData$groupingConfiguration": "The configuration information of the user groups that the quick response is accessible to.
", "QuickResponseSearchResultData$groupingConfiguration": "The configuration information of the user groups that the quick response is accessible to.
", "UpdateQuickResponseRequest$groupingConfiguration": "The updated grouping configuration of the quick response.
" } }, "GroupingCriteria": { "base": null, "refs": { "GroupingConfiguration$criteria": "The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
The headers to include in the upload.
" } }, "HierarchicalChunkingConfiguration": { "base": "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.
", "refs": { "ChunkingConfiguration$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.
" } }, "HierarchicalChunkingConfigurationOverlapTokensInteger": { "base": null, "refs": { "HierarchicalChunkingConfiguration$overlapTokens": "The number of tokens to repeat across chunks in the same layer.
" } }, "HierarchicalChunkingLevelConfiguration": { "base": "Token settings for each layer.
", "refs": { "HierarchicalChunkingLevelConfigurations$member": null } }, "HierarchicalChunkingLevelConfigurationMaxTokensInteger": { "base": null, "refs": { "HierarchicalChunkingLevelConfiguration$maxTokens": "The maximum number of tokens that a chunk can contain in this layer.
" } }, "HierarchicalChunkingLevelConfigurations": { "base": null, "refs": { "HierarchicalChunkingConfiguration$levelConfigurations": "Token settings for each layer.
" } }, "Highlight": { "base": "Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
", "refs": { "Highlights$member": null } }, "HighlightOffset": { "base": null, "refs": { "Highlight$beginOffsetInclusive": "The offset for the start of the highlight.
", "Highlight$endOffsetExclusive": "The offset for the end of the highlight.
" } }, "Highlights": { "base": null, "refs": { "DocumentText$highlights": "Highlights in the document text.
" } }, "ImportJobData": { "base": "Summary information about the import job.
", "refs": { "GetImportJobResponse$importJob": "The import job.
", "StartImportJobResponse$importJob": "The import job.
" } }, "ImportJobList": { "base": null, "refs": { "ListImportJobsResponse$importJobSummaries": "Summary information about the import jobs.
" } }, "ImportJobStatus": { "base": null, "refs": { "ImportJobData$status": "The status of the import job.
", "ImportJobSummary$status": "The status of the import job.
" } }, "ImportJobSummary": { "base": "Summary information about the import job.
", "refs": { "ImportJobList$member": null } }, "ImportJobType": { "base": null, "refs": { "ImportJobData$importJobType": "The type of the import job.
", "ImportJobSummary$importJobType": "The type of import job.
", "StartImportJobRequest$importJobType": "The type of the import job.
For importing quick response resource, set the value to QUICK_RESPONSES.
Details about the detected intent.
", "refs": { "DataDetails$intentDetectedData": "Details about the intent data.
" } }, "IntentInputData": { "base": "Information about the Amazon Q intent.
", "refs": { "QueryInputData$intentInputData": "Input information for the intent.
" } }, "KnowledgeBaseAssociationConfigurationData": { "base": "The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
Association information about the knowledge base.
", "refs": { "AssistantAssociationOutputData$knowledgeBaseAssociation": "The knowledge base where output data is sent.
" } }, "KnowledgeBaseData": { "base": "Information about the knowledge base.
", "refs": { "CreateKnowledgeBaseResponse$knowledgeBase": "The knowledge base.
", "GetKnowledgeBaseResponse$knowledgeBase": "The knowledge base.
", "UpdateKnowledgeBaseTemplateUriResponse$knowledgeBase": "The knowledge base to update.
" } }, "KnowledgeBaseList": { "base": null, "refs": { "ListKnowledgeBasesResponse$knowledgeBaseSummaries": "Information about the knowledge bases.
" } }, "KnowledgeBaseSearchType": { "base": null, "refs": { "KnowledgeBaseAssociationConfigurationData$overrideKnowledgeBaseSearchType": "The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
The status of the knowledge base.
", "KnowledgeBaseSummary$status": "The status of the knowledge base summary.
" } }, "KnowledgeBaseSummary": { "base": "Summary information about the knowledge base.
", "refs": { "KnowledgeBaseList$member": null } }, "KnowledgeBaseType": { "base": null, "refs": { "CreateKnowledgeBaseRequest$knowledgeBaseType": "The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
", "KnowledgeBaseData$knowledgeBaseType": "The type of knowledge base.
", "KnowledgeBaseSummary$knowledgeBaseType": "The type of knowledge base.
" } }, "LanguageCode": { "base": null, "refs": { "CreateQuickResponseRequest$language": "The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The language code value for the language in which the quick response is written.
", "QuickResponseSearchResultData$language": "The language code value for the language in which the quick response is written.
", "UpdateQuickResponseRequest$language": "The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
The identifier of the LLM model.
" } }, "ManagedSourceConfiguration": { "base": "Source configuration for managed resources.
", "refs": { "SourceConfiguration$managedSourceConfiguration": "Source configuration for managed resources.
" } }, "ManualSearchAIAgentConfiguration": { "base": "The configuration for the MANUAL_SEARCH AI Agent type.
The configuration for AI Agents of type MANUAL_SEARCH.
The maximum number of results to return per page.
", "KnowledgeBaseAssociationConfigurationData$maxResults": "The maximum number of results to return per page.
", "ListAIAgentVersionsRequest$maxResults": "The maximum number of results to return per page.
", "ListAIAgentsRequest$maxResults": "The maximum number of results to return per page.
", "ListAIPromptVersionsRequest$maxResults": "The maximum number of results to return per page.
", "ListAIPromptsRequest$maxResults": "The maximum number of results to return per page.
", "ListAssistantAssociationsRequest$maxResults": "The maximum number of results to return per page.
", "ListAssistantsRequest$maxResults": "The maximum number of results to return per page.
", "ListContentAssociationsRequest$maxResults": "The maximum number of results to return per page.
", "ListContentsRequest$maxResults": "The maximum number of results to return per page.
", "ListImportJobsRequest$maxResults": "The maximum number of results to return per page.
", "ListKnowledgeBasesRequest$maxResults": "The maximum number of results to return per page.
", "ListQuickResponsesRequest$maxResults": "The maximum number of results to return per page.
", "QueryAssistantRequest$maxResults": "The maximum number of results to return per page.
", "SearchContentRequest$maxResults": "The maximum number of results to return per page.
", "SearchQuickResponsesRequest$maxResults": "The maximum number of results to return per page.
", "SearchSessionsRequest$maxResults": "The maximum number of results to return per page.
" } }, "Name": { "base": null, "refs": { "AIAgentData$name": "The name of the AI Agent.
", "AIAgentSummary$name": "The name of the AI Agent.
", "AIPromptData$name": "The name of the AI Prompt
", "AIPromptSummary$name": "The name of the AI Prompt.
", "AssistantData$name": "The name.
", "AssistantSummary$name": "The name of the assistant.
", "ContentData$name": "The name of the content.
", "ContentSummary$name": "The name of the content.
", "CreateAIAgentRequest$name": "The name of the AI Agent.
", "CreateAIPromptRequest$name": "The name of the AI Prompt.
", "CreateAssistantRequest$name": "The name of the assistant.
", "CreateContentRequest$name": "The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
", "CreateKnowledgeBaseRequest$name": "The name of the knowledge base.
", "CreateSessionRequest$name": "The name of the session.
", "KnowledgeBaseData$name": "The name of the knowledge base.
", "KnowledgeBaseSummary$name": "The name of the knowledge base.
", "SessionData$name": "The name of the session.
" } }, "NextToken": { "base": null, "refs": { "ListAIAgentVersionsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIAgentVersionsResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIAgentsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIAgentsResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIPromptVersionsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIPromptVersionsResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIPromptsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAIPromptsResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAssistantAssociationsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAssistantAssociationsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListAssistantsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListAssistantsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListContentAssociationsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListContentAssociationsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListContentsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListContentsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "QueryAssistantRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "QueryAssistantResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "SearchContentRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "SearchContentResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "SearchSessionsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "SearchSessionsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
" } }, "NonEmptySensitiveString": { "base": null, "refs": { "RuntimeSessionData$key": "The key of the data stored on the session.
", "RuntimeSessionDataValue$stringValue": "The string value of the data stored on the session.
" } }, "NonEmptyString": { "base": null, "refs": { "ConnectConfiguration$instanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "ContentData$revisionId": "The identifier of the content revision.
", "ContentMetadata$key": null, "ContentMetadata$value": null, "ContentSummary$revisionId": "The identifier of the revision of the content.
", "CreateContentRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateKnowledgeBaseRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateQuickResponseRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "FailureReason$member": null, "Filter$value": "The desired field value on which to filter.
", "Headers$key": null, "Headers$value": null, "ListImportJobsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListImportJobsResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListKnowledgeBasesRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListKnowledgeBasesResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListQuickResponsesRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListQuickResponsesResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ObjectFieldsList$member": null, "QueryConditionItem$value": "The value for the query condition to query on.
", "QuickResponseFilterField$name": "The name of the attribute field to filter the quick responses by.
", "QuickResponseOrderField$name": "The name of the attribute to order the quick response query results by.
", "QuickResponseQueryField$name": "The name of the attribute to query the quick responses by.
", "SearchQuickResponsesRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "SearchQuickResponsesResponse$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ServerSideEncryptionConfiguration$kmsKeyId": "The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).
", "StartImportJobRequest$clientToken": "The tags used to organize, track, or control access for this resource.
", "UpdateContentRequest$revisionId": "The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.
An error occurred when creating a recommendation.
", "refs": { "NotifyRecommendationsReceivedErrorList$member": null } }, "NotifyRecommendationsReceivedErrorList": { "base": null, "refs": { "NotifyRecommendationsReceivedResponse$errors": "The identifiers of recommendations that are causing errors.
" } }, "NotifyRecommendationsReceivedErrorMessage": { "base": null, "refs": { "NotifyRecommendationsReceivedError$message": "A recommendation is causing an error.
" } }, "NotifyRecommendationsReceivedRequest": { "base": null, "refs": { } }, "NotifyRecommendationsReceivedResponse": { "base": null, "refs": { } }, "ObjectFieldsList": { "base": null, "refs": { "AppIntegrationsConfiguration$objectFields": "The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.
For Zendesk, you must include at least id, title, updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
" } }, "OrCondition": { "base": "A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an OR condition.
The order at which the quick responses are sorted by.
" } }, "Origin": { "base": null, "refs": { "AIAgentData$origin": "Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The origin of the AI Prompt versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
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.
", "refs": { "VectorIngestionConfiguration$parsingConfiguration": "A custom parser for data source documents.
" } }, "ParsingPrompt": { "base": "Instructions for interpreting the contents of a document.
", "refs": { "BedrockFoundationModelConfigurationForParsing$parsingPrompt": "Instructions for interpreting the contents of a document.
" } }, "ParsingPromptText": { "base": null, "refs": { "ParsingPrompt$parsingPromptText": "Instructions for interpreting the contents of a document.
" } }, "ParsingStrategy": { "base": null, "refs": { "ParsingConfiguration$parsingStrategy": "The parsing strategy for the data source.
" } }, "PreconditionFailedException": { "base": "The provided revisionId does not match, indicating the content has been modified since it was last read.
The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
" } }, "PutFeedbackRequest": { "base": null, "refs": { } }, "PutFeedbackResponse": { "base": null, "refs": { } }, "QueryAssistantRequest": { "base": null, "refs": { } }, "QueryAssistantResponse": { "base": null, "refs": { } }, "QueryCondition": { "base": "Information about how to query content.
", "refs": { "QueryConditionExpression$member": null } }, "QueryConditionComparisonOperator": { "base": null, "refs": { "QueryConditionItem$comparator": "The comparison operator for query condition to query on.
" } }, "QueryConditionExpression": { "base": null, "refs": { "QueryAssistantRequest$queryCondition": "Information about how to query content.
" } }, "QueryConditionFieldName": { "base": null, "refs": { "QueryConditionItem$field": "The name of the field for query condition to query on.
" } }, "QueryConditionItem": { "base": "The condition for the query.
", "refs": { "QueryCondition$single": "The condition for the query.
" } }, "QueryInputData": { "base": "Input information for the query.
", "refs": { "QueryAssistantRequest$queryInputData": "Information about the query.
" } }, "QueryRecommendationTriggerData": { "base": "Data associated with the QUERY RecommendationTriggerType.
", "refs": { "RecommendationTriggerData$query": "Data associated with the QUERY RecommendationTriggerType.
" } }, "QueryResultType": { "base": null, "refs": { "ResultData$type": "The type of the query result.
" } }, "QueryResultsList": { "base": null, "refs": { "QueryAssistantResponse$results": "The results of the query.
" } }, "QueryText": { "base": null, "refs": { "QueryAssistantRequest$queryText": "The text to search for.
", "QueryRecommendationTriggerData$text": "The text associated with the recommendation trigger.
", "QueryTextInputData$text": "The text to search for.
" } }, "QueryTextInputData": { "base": "Information about the text to search for.
", "refs": { "QueryInputData$queryTextInputData": "Input information for the query.
" } }, "QuickResponseContent": { "base": null, "refs": { "QuickResponseContentProvider$content": "The content of the quick response.
", "QuickResponseDataProvider$content": "The content of the quick response.
" } }, "QuickResponseContentProvider": { "base": "The container quick response content.
", "refs": { "QuickResponseContents$markdown": null, "QuickResponseContents$plainText": null } }, "QuickResponseContents": { "base": "The content of the quick response stored in different media types.
", "refs": { "QuickResponseData$contents": "The contents of the quick response.
", "QuickResponseSearchResultData$contents": "The contents of the quick response.
" } }, "QuickResponseData": { "base": "Information about the quick response.
", "refs": { "CreateQuickResponseResponse$quickResponse": "The quick response.
", "GetQuickResponseResponse$quickResponse": "The quick response.
", "UpdateQuickResponseResponse$quickResponse": "The quick response.
" } }, "QuickResponseDataProvider": { "base": "The container of quick response data.
", "refs": { "CreateQuickResponseRequest$content": "The content of the quick response.
", "UpdateQuickResponseRequest$content": "The updated content of the quick response.
" } }, "QuickResponseDescription": { "base": null, "refs": { "CreateQuickResponseRequest$description": "The description of the quick response.
", "QuickResponseData$description": "The description of the quick response.
", "QuickResponseSearchResultData$description": "The description of the quick response.
", "QuickResponseSummary$description": "The description of the quick response.
", "UpdateQuickResponseRequest$description": "The updated description of the quick response.
" } }, "QuickResponseFilterField": { "base": "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
The configuration of filtering rules applied to quick response query results.
" } }, "QuickResponseFilterOperator": { "base": null, "refs": { "QuickResponseFilterField$operator": "The operator to use for filtering.
" } }, "QuickResponseFilterValue": { "base": null, "refs": { "QuickResponseFilterValueList$member": null } }, "QuickResponseFilterValueList": { "base": null, "refs": { "QuickResponseFilterField$values": "The values of attribute field to filter the quick response by.
" } }, "QuickResponseName": { "base": null, "refs": { "CreateQuickResponseRequest$name": "The name of the quick response.
", "QuickResponseData$name": "The name of the quick response.
", "QuickResponseSearchResultData$name": "The name of the quick response.
", "QuickResponseSummary$name": "The name of the quick response.
", "UpdateQuickResponseRequest$name": "The name of the quick response.
" } }, "QuickResponseOrderField": { "base": "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
The quick response attribute fields on which the query results are ordered.
" } }, "QuickResponseQueryField": { "base": "The quick response fields to query quick responses by.
The following is the list of supported field names.
content
name
description
shortcutKey
The quick response query expressions.
" } }, "QuickResponseQueryOperator": { "base": null, "refs": { "QuickResponseQueryField$operator": "The operator to use for matching attribute field values in the query.
" } }, "QuickResponseQueryValue": { "base": null, "refs": { "QuickResponseQueryValueList$member": null } }, "QuickResponseQueryValueList": { "base": null, "refs": { "QuickResponseQueryField$values": "The values of the attribute to query the quick responses by.
" } }, "QuickResponseSearchExpression": { "base": "Information about the import job.
", "refs": { "SearchQuickResponsesRequest$searchExpression": "The search expression for querying the quick response.
" } }, "QuickResponseSearchResultData": { "base": "The result of quick response search.
", "refs": { "QuickResponseSearchResultsList$member": null } }, "QuickResponseSearchResultsList": { "base": null, "refs": { "SearchQuickResponsesResponse$results": "The results of the quick response search.
" } }, "QuickResponseStatus": { "base": null, "refs": { "QuickResponseData$status": "The status of the quick response data.
", "QuickResponseSearchResultData$status": "The resource status of the quick response.
", "QuickResponseSummary$status": "The resource status of the quick response.
" } }, "QuickResponseSummary": { "base": "The summary information about the quick response.
", "refs": { "QuickResponseSummaryList$member": null } }, "QuickResponseSummaryList": { "base": null, "refs": { "ListQuickResponsesResponse$quickResponseSummaries": "Summary information about the quick responses.
" } }, "QuickResponseType": { "base": null, "refs": { "CreateQuickResponseRequest$contentType": "The media type of the quick response content.
Use application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The media type of the quick response content.
Use application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
Details about the source content ranking data.
", "refs": { "ContentDataDetails$rankingData": "Details about the content ranking data.
", "GenerativeDataDetails$rankingData": "Details about the generative content ranking data.
", "SourceContentDataDetails$rankingData": "Details about the source content ranking data.
" } }, "RecommendationData": { "base": "Information about the recommendation.
", "refs": { "RecommendationList$member": null } }, "RecommendationId": { "base": null, "refs": { "NotifyRecommendationsReceivedError$recommendationId": "The identifier of the recommendation that is in error.
", "RecommendationData$recommendationId": "The identifier of the recommendation.
", "RecommendationIdList$member": null } }, "RecommendationIdList": { "base": null, "refs": { "NotifyRecommendationsReceivedRequest$recommendationIds": "The identifiers of the recommendations.
", "NotifyRecommendationsReceivedResponse$recommendationIds": "The identifiers of the recommendations.
", "RecommendationTrigger$recommendationIds": "The identifiers of the recommendations.
" } }, "RecommendationList": { "base": null, "refs": { "GetRecommendationsResponse$recommendations": "The recommendations.
" } }, "RecommendationSourceType": { "base": null, "refs": { "RecommendationTrigger$source": "The source of the recommendation trigger.
ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.
RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.
A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
A union type containing information related to the trigger.
", "refs": { "RecommendationTrigger$data": "A union type containing information related to the trigger.
" } }, "RecommendationTriggerList": { "base": null, "refs": { "GetRecommendationsResponse$triggers": "The triggers corresponding to recommendations.
" } }, "RecommendationTriggerType": { "base": null, "refs": { "RecommendationTrigger$type": "The type of recommendation trigger.
" } }, "RecommendationType": { "base": null, "refs": { "RecommendationData$type": "The type of recommendation.
" } }, "ReferenceType": { "base": null, "refs": { "ContentReference$referenceType": "The type of reference content.
" } }, "Relevance": { "base": null, "refs": { "GenerativeContentFeedbackData$relevance": "The relevance of the feedback.
" } }, "RelevanceLevel": { "base": null, "refs": { "RankingData$relevanceLevel": "The relevance score of the content.
", "RecommendationData$relevanceLevel": "The relevance level of the recommendation.
" } }, "RelevanceScore": { "base": null, "refs": { "RankingData$relevanceScore": "The relevance level of the recommendation.
", "RecommendationData$relevanceScore": "The relevance score of the recommendation.
", "ResultData$relevanceScore": "The relevance score of the results.
" } }, "RemoveAssistantAIAgentRequest": { "base": null, "refs": { } }, "RemoveAssistantAIAgentResponse": { "base": null, "refs": { } }, "RemoveKnowledgeBaseTemplateUriRequest": { "base": null, "refs": { } }, "RemoveKnowledgeBaseTemplateUriResponse": { "base": null, "refs": { } }, "RenderingConfiguration": { "base": "Information about how to render the content.
", "refs": { "CreateKnowledgeBaseRequest$renderingConfiguration": "Information about how to render the content.
", "KnowledgeBaseData$renderingConfiguration": "Information about how to render the content.
", "KnowledgeBaseSummary$renderingConfiguration": "Information about how to render the content.
" } }, "RequestTimeoutException": { "base": "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.
", "refs": { } }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", "refs": { } }, "ResultData": { "base": "Information about the result.
", "refs": { "QueryResultsList$member": null } }, "RuntimeSessionData": { "base": "The list of key-value pairs that are stored on the session.
", "refs": { "RuntimeSessionDataList$member": null } }, "RuntimeSessionDataList": { "base": null, "refs": { "UpdateSessionDataRequest$data": "The data stored on the Amazon Q in Connect Session.
", "UpdateSessionDataResponse$data": "Data stored in the session.
" } }, "RuntimeSessionDataValue": { "base": "A union type that specifies the data stored on the session.
", "refs": { "RuntimeSessionData$value": "The value of the data stored on the session.
" } }, "SearchContentRequest": { "base": null, "refs": { } }, "SearchContentResponse": { "base": null, "refs": { } }, "SearchExpression": { "base": "The search expression.
", "refs": { "SearchContentRequest$searchExpression": "The search expression to filter results.
", "SearchSessionsRequest$searchExpression": "The search expression to filter results.
" } }, "SearchQuickResponsesRequest": { "base": null, "refs": { } }, "SearchQuickResponsesResponse": { "base": null, "refs": { } }, "SearchSessionsRequest": { "base": null, "refs": { } }, "SearchSessionsResponse": { "base": null, "refs": { } }, "SeedUrl": { "base": "A URL for crawling.
", "refs": { "SeedUrls$member": null } }, "SeedUrls": { "base": null, "refs": { "UrlConfiguration$seedUrls": "List of URLs for crawling.
" } }, "SemanticChunkingConfiguration": { "base": "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.
", "refs": { "ChunkingConfiguration$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.
" } }, "SemanticChunkingConfigurationBreakpointPercentileThresholdInteger": { "base": null, "refs": { "SemanticChunkingConfiguration$breakpointPercentileThreshold": "The dissimilarity threshold for splitting chunks.
" } }, "SemanticChunkingConfigurationBufferSizeInteger": { "base": null, "refs": { "SemanticChunkingConfiguration$bufferSize": "The buffer size.
" } }, "SemanticChunkingConfigurationMaxTokensInteger": { "base": null, "refs": { "SemanticChunkingConfiguration$maxTokens": "The maximum number of tokens that a chunk can contain.
" } }, "SensitiveString": { "base": null, "refs": { "DocumentText$text": "Text in the document.
", "GenerativeDataDetails$completion": "The LLM response.
", "IntentDetectedDataDetails$intent": "The detected intent.
" } }, "ServerSideEncryptionConfiguration": { "base": "The configuration information for the customer managed key used for encryption.
", "refs": { "AssistantData$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
", "AssistantSummary$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
", "CreateAssistantRequest$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
", "CreateKnowledgeBaseRequest$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
", "KnowledgeBaseData$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
", "KnowledgeBaseSummary$serverSideEncryptionConfiguration": "The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
" } }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { } }, "SessionData": { "base": "Information about the session.
", "refs": { "CreateSessionResponse$session": "The session.
", "GetSessionResponse$session": "The session.
", "UpdateSessionResponse$session": null } }, "SessionDataNamespace": { "base": null, "refs": { "UpdateSessionDataRequest$namespace": "The namespace into which the session data is stored. Supported namespaces are: Custom
", "UpdateSessionDataResponse$namespace": "The namespace into which the session data is stored. Supported namespaces are: Custom
" } }, "SessionIntegrationConfiguration": { "base": "The configuration information for the session integration.
", "refs": { "SessionData$integrationConfiguration": "The configuration information for the session integration.
" } }, "SessionSummaries": { "base": null, "refs": { "SearchSessionsResponse$sessionSummaries": "Summary information about the sessions.
" } }, "SessionSummary": { "base": "Summary information about the session.
", "refs": { "SessionSummaries$member": null } }, "ShortCutKey": { "base": null, "refs": { "CreateQuickResponseRequest$shortcutKey": "The shortcut key of the quick response. The value should be unique across the knowledge base.
", "QuickResponseData$shortcutKey": "The shortcut key of the quick response. The value should be unique across the knowledge base.
", "QuickResponseSearchResultData$shortcutKey": "The shortcut key of the quick response. The value should be unique across the knowledge base.
", "UpdateQuickResponseRequest$shortcutKey": "The shortcut key of the quick response. The value should be unique across the knowledge base.
" } }, "SourceConfiguration": { "base": "Configuration information about the external data source.
", "refs": { "CreateKnowledgeBaseRequest$sourceConfiguration": "The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
", "KnowledgeBaseData$sourceConfiguration": "Source configuration information about the knowledge base.
", "KnowledgeBaseSummary$sourceConfiguration": "Configuration information about the external data source.
" } }, "SourceContentDataDetails": { "base": "Details about the source content data.
", "refs": { "DataDetails$sourceContentData": "Details about the content data.
" } }, "SourceContentType": { "base": null, "refs": { "SourceContentDataDetails$type": "The type of the source content.
" } }, "StartContentUploadRequest": { "base": null, "refs": { } }, "StartContentUploadResponse": { "base": null, "refs": { } }, "StartImportJobRequest": { "base": null, "refs": { } }, "StartImportJobResponse": { "base": null, "refs": { } }, "Status": { "base": null, "refs": { "AIAgentData$status": "The status of the AI Agent.
", "AIAgentSummary$status": "The status of the AI Agent.
", "AIPromptData$status": "The status of the AI Prompt.
", "AIPromptSummary$status": "The status of the AI Prompt.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "ContentReference$sourceURL": "The web URL of the source content.
", "PreconditionFailedException$message": null, "RequestTimeoutException$message": null, "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceName": "The specified resource name.
", "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "TooManyTagsException$message": null, "TooManyTagsException$resourceName": "The specified resource name.
", "ValidationException$message": null } }, "SyncStatus": { "base": null, "refs": { "KnowledgeBaseData$ingestionStatus": "Status of ingestion on data source.
" } }, "SyntheticTimestamp_epoch_seconds": { "base": null, "refs": { "ContentData$urlExpiry": "The expiration time of the URL as an epoch timestamp.
", "ImportJobData$createdTime": "The timestamp when the import job was created.
", "ImportJobData$lastModifiedTime": "The timestamp when the import job data was last modified.
", "ImportJobData$urlExpiry": "The expiration time of the URL as an epoch timestamp.
", "ImportJobSummary$createdTime": "The timestamp when the import job was created.
", "ImportJobSummary$lastModifiedTime": "The timestamp when the import job was last modified.
", "KnowledgeBaseData$lastContentModificationTime": "An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
", "QuickResponseData$createdTime": "The timestamp when the quick response was created.
", "QuickResponseData$lastModifiedTime": "The timestamp when the quick response data was last modified.
", "QuickResponseSearchResultData$createdTime": "The timestamp when the quick response was created.
", "QuickResponseSearchResultData$lastModifiedTime": "The timestamp when the quick response search result data was last modified.
", "QuickResponseSummary$createdTime": "The timestamp when the quick response was created.
", "QuickResponseSummary$lastModifiedTime": "The timestamp when the quick response summary was last modified.
", "StartContentUploadResponse$urlExpiry": "The expiration time of the URL as an epoch timestamp.
" } }, "TagCondition": { "base": "A leaf node condition which can be used to specify a tag condition.
", "refs": { "AndConditions$member": null, "OrCondition$tagCondition": "A leaf node condition which can be used to specify a tag condition.
", "TagFilter$tagCondition": "A leaf node condition which can be used to specify a tag condition.
" } }, "TagFilter": { "base": "An object that can be used to specify Tag conditions.
", "refs": { "CreateSessionRequest$tagFilter": "An object that can be used to specify Tag conditions.
", "KnowledgeBaseAssociationConfigurationData$contentTagFilter": null, "SessionData$tagFilter": "An object that can be used to specify Tag conditions.
", "UpdateSessionRequest$tagFilter": "An object that can be used to specify Tag conditions.
" } }, "TagKey": { "base": null, "refs": { "TagCondition$key": "The tag key in the tag condition.
", "TagKeyList$member": null, "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag keys.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagCondition$value": "The tag value in the tag condition.
", "Tags$value": null } }, "Tags": { "base": null, "refs": { "AIAgentData$tags": "The tags used to organize, track, or control access for this resource.
", "AIAgentSummary$tags": "The tags used to organize, track, or control access for this resource.
", "AIPromptData$tags": "The tags used to organize, track, or control access for this resource.
", "AIPromptSummary$tags": "The tags used to organize, track, or control access for this resource.
", "AssistantAssociationData$tags": "The tags used to organize, track, or control access for this resource.
", "AssistantAssociationSummary$tags": "The tags used to organize, track, or control access for this resource.
", "AssistantData$tags": "The tags used to organize, track, or control access for this resource.
", "AssistantSummary$tags": "The tags used to organize, track, or control access for this resource.
", "ContentAssociationData$tags": "The tags used to organize, track, or control access for this resource.
", "ContentAssociationSummary$tags": "The tags used to organize, track, or control access for this resource.
", "ContentData$tags": "The tags used to organize, track, or control access for this resource.
", "ContentSummary$tags": "The tags used to organize, track, or control access for this resource.
", "CreateAIAgentRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateAIPromptRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateAssistantAssociationRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateAssistantRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateContentAssociationRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateContentRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateKnowledgeBaseRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateQuickResponseRequest$tags": "The tags used to organize, track, or control access for this resource.
", "CreateSessionRequest$tags": "The tags used to organize, track, or control access for this resource.
", "KnowledgeBaseData$tags": "The tags used to organize, track, or control access for this resource.
", "KnowledgeBaseSummary$tags": "The tags used to organize, track, or control access for this resource.
", "ListTagsForResourceResponse$tags": "The tags used to organize, track, or control access for this resource.
", "QuickResponseData$tags": "The tags used to organize, track, or control access for this resource.
", "QuickResponseSearchResultData$tags": "The tags used to organize, track, or control access for this resource.
", "QuickResponseSummary$tags": "The tags used to organize, track, or control access for this resource.
", "SessionData$tags": "The tags used to organize, track, or control access for this resource.
", "TagResourceRequest$tags": "The tags used to organize, track, or control access for this resource.
" } }, "TargetType": { "base": null, "refs": { "PutFeedbackRequest$targetType": "The type of the feedback target.
", "PutFeedbackResponse$targetType": "The type of the feedback target.
" } }, "TextAIPrompt": { "base": null, "refs": { "TextFullAIPromptEditTemplateConfiguration$text": "The YAML text for the AI Prompt template.
" } }, "TextData": { "base": "Details about the source content text data.
", "refs": { "ContentDataDetails$textData": "Details about the content text data.
", "SourceContentDataDetails$textData": "Details about the source content text data.
" } }, "TextFullAIPromptEditTemplateConfiguration": { "base": "The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
", "refs": { "AIPromptTemplateConfiguration$textFullAIPromptEditTemplateConfiguration": "The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
" } }, "ThrottlingException": { "base": "The throttling limit has been exceeded.
", "refs": { } }, "TimeToLive": { "base": "Expiration time in minutes
", "refs": { "StartContentUploadRequest$presignedUrlTimeToLive": "The expected expiration time of the generated presigned URL, specified in minutes.
" } }, "Timestamp": { "base": null, "refs": { "AIAgentData$modifiedTime": "The time the AI Agent was last modified.
", "AIAgentSummary$modifiedTime": "The time the AI Agent was last modified.
", "AIPromptData$modifiedTime": "The time the AI Prompt was last modified.
", "AIPromptSummary$modifiedTime": "The time the AI Prompt was last modified.
", "CreateAIAgentVersionRequest$modifiedTime": "The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.
", "CreateAIPromptVersionRequest$modifiedTime": "The time the AI Prompt was last modified.
" } }, "TooManyTagsException": { "base": "Amazon Q in Connect throws this exception if you have too many tags in your tag set.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAIAgentRequest": { "base": null, "refs": { } }, "UpdateAIAgentResponse": { "base": null, "refs": { } }, "UpdateAIPromptRequest": { "base": null, "refs": { } }, "UpdateAIPromptResponse": { "base": null, "refs": { } }, "UpdateAssistantAIAgentRequest": { "base": null, "refs": { } }, "UpdateAssistantAIAgentResponse": { "base": null, "refs": { } }, "UpdateContentRequest": { "base": null, "refs": { } }, "UpdateContentResponse": { "base": null, "refs": { } }, "UpdateKnowledgeBaseTemplateUriRequest": { "base": null, "refs": { } }, "UpdateKnowledgeBaseTemplateUriResponse": { "base": null, "refs": { } }, "UpdateQuickResponseRequest": { "base": null, "refs": { } }, "UpdateQuickResponseResponse": { "base": null, "refs": { } }, "UpdateSessionDataRequest": { "base": null, "refs": { } }, "UpdateSessionDataResponse": { "base": null, "refs": { } }, "UpdateSessionRequest": { "base": null, "refs": { } }, "UpdateSessionResponse": { "base": null, "refs": { } }, "UploadId": { "base": null, "refs": { "CreateContentRequest$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "ImportJobData$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "ImportJobSummary$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "StartContentUploadResponse$uploadId": "The identifier of the upload.
", "StartImportJobRequest$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "UpdateContentRequest$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } }, "Uri": { "base": null, "refs": { "ContentData$linkOutUri": "The URI of the content.
", "CreateContentRequest$overrideLinkOutUri": "The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
", "RenderingConfiguration$templateUri": "A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted
ServiceNow: number, short_description, sys_mod_count, workflow_state, or active
Zendesk: id, title, updated_at, or draft
The variable is replaced with the actual value for a piece of content when calling GetContent.
", "UpdateContentRequest$overrideLinkOutUri": "The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.
The template URI to update.
" } }, "Url": { "base": null, "refs": { "ContentData$url": "The URL of the content.
", "ImportJobData$failedRecordReport": "The link to download the information of resource data that failed to be imported.
", "ImportJobData$url": "The download link to the resource file that is uploaded to the import job.
", "StartContentUploadResponse$url": "The URL of the upload.
" } }, "UrlConfiguration": { "base": "The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
", "refs": { "WebCrawlerConfiguration$urlConfiguration": "The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" } }, "UrlFilterList": { "base": null, "refs": { "WebCrawlerConfiguration$exclusionFilters": "A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
", "WebCrawlerConfiguration$inclusionFilters": "A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" } }, "UrlFilterPattern": { "base": null, "refs": { "UrlFilterList$member": null } }, "Uuid": { "base": null, "refs": { "AIAgentData$aiAgentId": "The identifier of the AI Agent.
", "AIAgentData$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIAgentSummary$aiAgentId": "The identifier of the AI Agent.
", "AIAgentSummary$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIPromptData$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "AIPromptData$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIPromptSummary$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "AIPromptSummary$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AssistantAssociationData$assistantAssociationId": "The identifier of the assistant association.
", "AssistantAssociationData$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "AssistantAssociationInputData$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", "AssistantAssociationSummary$assistantAssociationId": "The identifier of the assistant association.
", "AssistantAssociationSummary$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "AssistantData$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "AssistantSummary$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "AssociationConfiguration$associationId": "The identifier of the association for this Association Configuration.
", "ContentAssociationData$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ContentAssociationData$contentId": "The identifier of the content.
", "ContentAssociationData$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentAssociationSummary$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ContentAssociationSummary$contentId": "The identifier of the content.
", "ContentAssociationSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentData$contentId": "The identifier of the content.
", "ContentData$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentReference$contentId": "The identifier of the content.
", "ContentReference$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", "ContentSummary$contentId": "The identifier of the content.
", "ContentSummary$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", "DeleteImportJobRequest$importJobId": "The identifier of the import job to be deleted.
", "GenerativeReference$generationId": "The identifier of the LLM model.
", "GetImportJobRequest$importJobId": "The identifier of the import job to retrieve.
", "ImportJobData$importJobId": "The identifier of the import job.
", "ImportJobData$knowledgeBaseId": "The identifier of the knowledge base.
", "ImportJobSummary$importJobId": "The identifier of the import job.
", "ImportJobSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "IntentDetectedDataDetails$intentId": "The identifier of the detected intent.
", "IntentInputData$intentId": "The identifier of the Amazon Q intent.
", "KnowledgeBaseAssociationData$knowledgeBaseId": "The identifier of the knowledge base.
", "KnowledgeBaseData$knowledgeBaseId": "The identifier of the knowledge base.
", "KnowledgeBaseSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "PutFeedbackRequest$targetId": "The identifier of the feedback target.
", "PutFeedbackResponse$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "PutFeedbackResponse$targetId": "The identifier of the feedback target.
", "QuickResponseData$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "QuickResponseData$quickResponseId": "The identifier of the quick response.
", "QuickResponseSearchResultData$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "QuickResponseSearchResultData$quickResponseId": "The identifier of the quick response.
", "QuickResponseSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "QuickResponseSummary$quickResponseId": "The identifier of the quick response.
", "RecommendationTrigger$id": "The identifier of the recommendation trigger.
", "ResultData$resultId": "The identifier of the result data.
", "SessionData$sessionId": "The identifier of the session.
", "SessionSummary$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "SessionSummary$sessionId": "The identifier of the session.
", "SourceContentDataDetails$id": "The identifier of the source content.
", "UpdateSessionDataResponse$sessionId": "The identifier of the session.
" } }, "UuidOrArn": { "base": null, "refs": { "CreateAIAgentRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateAIAgentVersionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateAIPromptRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateAIPromptVersionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateAssistantAssociationRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateContentAssociationRequest$contentId": "The identifier of the content.
", "CreateContentAssociationRequest$knowledgeBaseId": "The identifier of the knowledge base.
", "CreateContentRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateQuickResponseRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateSessionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIAgentRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIAgentVersionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIPromptRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIPromptVersionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAssistantAssociationRequest$assistantAssociationId": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAssistantAssociationRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAssistantRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteContentAssociationRequest$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteContentAssociationRequest$contentId": "The identifier of the content.
", "DeleteContentAssociationRequest$knowledgeBaseId": "The identifier of the knowledge base.
", "DeleteContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteContentRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteImportJobRequest$knowledgeBaseId": "The identifier of the knowledge base.
", "DeleteKnowledgeBaseRequest$knowledgeBaseId": "The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteQuickResponseRequest$knowledgeBaseId": "The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
", "DeleteQuickResponseRequest$quickResponseId": "The identifier of the quick response to delete.
", "GetAIAgentRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetAIPromptRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetAssistantAssociationRequest$assistantAssociationId": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetAssistantAssociationRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetAssistantRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetContentAssociationRequest$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetContentAssociationRequest$contentId": "The identifier of the content.
", "GetContentAssociationRequest$knowledgeBaseId": "The identifier of the knowledge base.
", "GetContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetContentRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetContentSummaryRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetContentSummaryRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetImportJobRequest$knowledgeBaseId": "The identifier of the knowledge base that the import job belongs to.
", "GetKnowledgeBaseRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetQuickResponseRequest$knowledgeBaseId": "The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
", "GetQuickResponseRequest$quickResponseId": "The identifier of the quick response.
", "GetRecommendationsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetRecommendationsRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetSessionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetSessionRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAIAgentVersionsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAIAgentsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAIPromptVersionsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAIPromptsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAssistantAssociationsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListContentAssociationsRequest$contentId": "The identifier of the content.
", "ListContentAssociationsRequest$knowledgeBaseId": "The identifier of the knowledge base.
", "ListContentsRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListImportJobsRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListQuickResponsesRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "NotifyRecommendationsReceivedRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "NotifyRecommendationsReceivedRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "PutFeedbackRequest$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "PutFeedbackResponse$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "QueryAssistantRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "QueryAssistantRequest$sessionId": "The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "RemoveAssistantAIAgentRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "RemoveKnowledgeBaseTemplateUriRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "SearchContentRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "SearchQuickResponsesRequest$knowledgeBaseId": "The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "SearchSessionsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "StartContentUploadRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "StartImportJobRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateAIPromptRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateAssistantAIAgentRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateContentRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
", "UpdateKnowledgeBaseTemplateUriRequest$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateQuickResponseRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateQuickResponseRequest$quickResponseId": "The identifier of the quick response.
", "UpdateSessionDataRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateSessionDataRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateSessionRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateSessionRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
" } }, "UuidOrArnOrEitherWithQualifier": { "base": null, "refs": { "CreateAIAgentVersionRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent.
", "CreateAIPromptVersionRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "DeleteAIAgentRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIAgentVersionRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIPromptRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIPromptVersionRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "GetAIAgentRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetAIPromptRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "ListAIAgentVersionsRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
", "ListAIPromptVersionsRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.
", "UpdateAIAgentRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent.
", "UpdateAIPromptRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI Prompt.
" } }, "UuidWithQualifier": { "base": null, "refs": { "AIAgentConfigurationData$aiAgentId": "The ID of the AI Agent to be configured.
", "AnswerRecommendationAIAgentConfiguration$answerGenerationAIPromptId": "The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by a service.
", "refs": { } }, "VectorIngestionConfiguration": { "base": "Contains details about how to ingest the documents in a data source.
", "refs": { "CreateKnowledgeBaseRequest$vectorIngestionConfiguration": "Contains details about how to ingest the documents in a data source.
", "KnowledgeBaseData$vectorIngestionConfiguration": "Contains details about how to ingest the documents in a data source.
", "KnowledgeBaseSummary$vectorIngestionConfiguration": "Contains details about how to ingest the documents in a data source.
" } }, "Version": { "base": null, "refs": { "AIAgentVersionSummary$versionNumber": "The version number for this AI Agent version.
", "AIPromptVersionSummary$versionNumber": "The version number for this AI Prompt version.
", "CreateAIAgentVersionResponse$versionNumber": "The version number of the AI Agent version.
", "CreateAIPromptVersionResponse$versionNumber": "The version number of the AI Prompt version.
", "DeleteAIAgentVersionRequest$versionNumber": "The version number of the AI Agent version.
", "DeleteAIPromptVersionRequest$versionNumber": "The version number of the AI Prompt version to be deleted.
", "GetAIAgentResponse$versionNumber": "The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the aiAgentId on the request).
The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).
The visibility status of the AI Agent.
", "AIAgentSummary$visibilityStatus": "The visibility status of the AI Agent.
", "AIPromptData$visibilityStatus": "The visibility status of the AI Prompt.
", "AIPromptSummary$visibilityStatus": "The visibility status of the AI Prompt.
", "CreateAIAgentRequest$visibilityStatus": "The visibility status of the AI Agent.
", "CreateAIPromptRequest$visibilityStatus": "The visibility status of the AI Prompt.
", "UpdateAIAgentRequest$visibilityStatus": "The visbility status of the Amazon Q in Connect AI Agent.
", "UpdateAIPromptRequest$visibilityStatus": "The visibility status of the Amazon Q in Connect AI prompt.
" } }, "WaitTimeSeconds": { "base": null, "refs": { "GetRecommendationsRequest$waitTimeSeconds": "The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.
The configuration details for the web data source.
", "refs": { "ManagedSourceConfiguration$webCrawlerConfiguration": "Configuration data for web crawler data source.
" } }, "WebCrawlerLimits": { "base": "The configuration of crawl limits for the web URLs.
", "refs": { "WebCrawlerConfiguration$crawlerLimits": "The configuration of crawl limits for the web URLs.
" } }, "WebCrawlerLimitsRateLimitInteger": { "base": null, "refs": { "WebCrawlerLimits$rateLimit": "Rate of web URLs retrieved per minute.
" } }, "WebScopeType": { "base": null, "refs": { "WebCrawlerConfiguration$scope": "The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com.
URL for crawling
" } } } }