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": { "ActivateMessageTemplate": "Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.
Creates an Amazon Q in Connect AI Agent.
", "CreateAIAgentVersion": "Creates and Amazon Q in Connect AI Agent version.
", "CreateAIGuardrail": "Creates an Amazon Q in Connect AI Guardrail.
", "CreateAIGuardrailVersion": "Creates an Amazon Q in Connect AI Guardrail version.
", "CreateAIPrompt": "Creates an Amazon Q in Connect AI Prompt.
For more information on supported models, see Supported models for system and custom prompts.
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 message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
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.
", "DeactivateMessageTemplate": "Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.
Deletes an Amazon Q in Connect AI Agent.
", "DeleteAIAgentVersion": "Deletes an Amazon Q in Connect AI Agent Version.
", "DeleteAIGuardrail": "Deletes an Amazon Q in Connect AI Guardrail.
", "DeleteAIGuardrailVersion": "Delete and Amazon Q in Connect AI Guardrail 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 an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
Deletes a quick response.
", "GetAIAgent": "Gets an Amazon Q in Connect AI Agent.
", "GetAIGuardrail": "Gets the Amazon Q in Connect AI Guardrail.
", "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.
", "GetMessageTemplate": "Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
Retrieves next message on an Amazon Q in Connect session.
", "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.
", "ListAIGuardrailVersions": "Lists AI Guardrail versions.
", "ListAIGuardrails": "Lists the AI Guardrails available on the Amazon Q in Connect assistant.
", "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.
", "ListMessageTemplateVersions": "Lists all the available versions for the specified Amazon Q in Connect message template.
", "ListMessageTemplates": "Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
", "ListMessages": "Lists messages on an Amazon Q in Connect session.
", "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 default on an Amazon Q in Connect Assistant.
", "RemoveKnowledgeBaseTemplateUri": "Removes a URI template from a knowledge base.
", "RenderMessageTemplate": "Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
", "SearchContent": "Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
", "SearchMessageTemplates": "Searches for Amazon Q in Connect message templates in the specified knowledge base.
", "SearchQuickResponses": "Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
", "SearchSessions": "Searches for sessions.
", "SendMessage": "Submits a message to the Amazon Q in Connect session.
", "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.
", "UpdateAIGuardrail": "Updates an AI Guardrail.
", "UpdateAIPrompt": "Updates an AI Prompt.
", "UpdateAssistantAIAgent": "Updates the AI Agent that is set for use by default 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 the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
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 } }, "AIGuardrailBlockedMessaging": { "base": "Messaging for when violations are detected in text
", "refs": { "AIGuardrailData$blockedInputMessaging": "The message to return when the AI Guardrail blocks a prompt.
", "AIGuardrailData$blockedOutputsMessaging": "The message to return when the AI Guardrail blocks a model response.
", "CreateAIGuardrailRequest$blockedInputMessaging": "The message to return when the AI Guardrail blocks a prompt.
", "CreateAIGuardrailRequest$blockedOutputsMessaging": "The message to return when the AI Guardrail blocks a model response.
", "UpdateAIGuardrailRequest$blockedInputMessaging": "The message to return when the AI Guardrail blocks a prompt.
", "UpdateAIGuardrailRequest$blockedOutputsMessaging": "The message to return when the AI Guardrail blocks a model response.
" } }, "AIGuardrailContentPolicyConfig": { "base": "Contains details about how to handle harmful content.
", "refs": { "AIGuardrailData$contentPolicyConfig": "Contains details about how to handle harmful content.
", "CreateAIGuardrailRequest$contentPolicyConfig": "The content filter policies to configure for the AI Guardrail.
", "UpdateAIGuardrailRequest$contentPolicyConfig": "The content filter policies to configure for the AI Guardrail.
" } }, "AIGuardrailContextualGroundingPolicyConfig": { "base": "The policy configuration details for the AI Guardrail's contextual grounding policy.
", "refs": { "AIGuardrailData$contextualGroundingPolicyConfig": "The policy configuration details for the AI Guardrail's contextual grounding policy.
", "CreateAIGuardrailRequest$contextualGroundingPolicyConfig": "The contextual grounding policy configuration used to create an AI Guardrail.
", "UpdateAIGuardrailRequest$contextualGroundingPolicyConfig": "The contextual grounding policy configuration used to create an AI Guardrail.
" } }, "AIGuardrailData": { "base": "The data for the AI Guardrail
", "refs": { "CreateAIGuardrailResponse$aiGuardrail": "The data of the AI Guardrail.
", "CreateAIGuardrailVersionResponse$aiGuardrail": "The data of the AI Guardrail version.
", "GetAIGuardrailResponse$aiGuardrail": "The data of the AI Guardrail.
", "UpdateAIGuardrailResponse$aiGuardrail": "The data of the updated Amazon Q in Connect AI Guardrail.
" } }, "AIGuardrailDescription": { "base": "Description of the guardrail or its version
", "refs": { "AIGuardrailData$description": "A description of the AI Guardrail.
", "AIGuardrailSummary$description": "A description of the AI Guardrail.
", "CreateAIGuardrailRequest$description": "A description of the AI Guardrail.
", "UpdateAIGuardrailRequest$description": "A description of the AI Guardrail.
" } }, "AIGuardrailSensitiveInformationPolicyConfig": { "base": "Contains details about PII entities and regular expressions to configure for the AI Guardrail.
", "refs": { "AIGuardrailData$sensitiveInformationPolicyConfig": "Contains details about PII entities and regular expressions to configure for the AI Guardrail.
", "CreateAIGuardrailRequest$sensitiveInformationPolicyConfig": "The sensitive information policy to configure for the AI Guardrail.
", "UpdateAIGuardrailRequest$sensitiveInformationPolicyConfig": "The sensitive information policy to configure for the AI Guardrail.
" } }, "AIGuardrailSummariesList": { "base": null, "refs": { "ListAIGuardrailsResponse$aiGuardrailSummaries": "The summaries of the AI Guardrails.
" } }, "AIGuardrailSummary": { "base": "The summary of the AI Guardrail.
", "refs": { "AIGuardrailSummariesList$member": null, "AIGuardrailVersionSummary$aiGuardrailSummary": "The data for the summary of the AI Guardrail version.
" } }, "AIGuardrailTopicPolicyConfig": { "base": "Contains details about topics that the AI Guardrail should identify and deny.
", "refs": { "AIGuardrailData$topicPolicyConfig": "Contains details about topics that the AI Guardrail should identify and deny.
", "CreateAIGuardrailRequest$topicPolicyConfig": "The topic policies to configure for the AI Guardrail.
", "UpdateAIGuardrailRequest$topicPolicyConfig": "The topic policies to configure for the AI Guardrail.
" } }, "AIGuardrailVersionSummariesList": { "base": null, "refs": { "ListAIGuardrailVersionsResponse$aiGuardrailVersionSummaries": "The summaries of the AI Guardrail versions.
" } }, "AIGuardrailVersionSummary": { "base": "The summary of the AI Guardrail version.
", "refs": { "AIGuardrailVersionSummariesList$member": null } }, "AIGuardrailWordPolicyConfig": { "base": "Contains details about the word policy to configured for the AI Guardrail.
", "refs": { "AIGuardrailData$wordPolicyConfig": "Contains details about the word policy to configured for the AI Guardrail.
", "CreateAIGuardrailRequest$wordPolicyConfig": "The word policy you configure for the AI Guardrail.
", "UpdateAIGuardrailRequest$wordPolicyConfig": "The word policy you configure for the AI Guardrail.
" } }, "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.
Recommended values: MESSAGES | TEXT_COMPLETIONS
The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.
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. The following model Ids are supported:
anthropic.claude-3-haiku--v1:0
apac.amazon.nova-lite-v1:0
apac.amazon.nova-micro-v1:0
apac.amazon.nova-pro-v1:0
apac.anthropic.claude-3-5-sonnet--v2:0
apac.anthropic.claude-3-haiku-20240307-v1:0
eu.amazon.nova-lite-v1:0
eu.amazon.nova-micro-v1:0
eu.amazon.nova-pro-v1:0
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
eu.anthropic.claude-3-haiku-20240307-v1:0
us.amazon.nova-lite-v1:0
us.amazon.nova-micro-v1:0
us.amazon.nova-pro-v1:0
us.anthropic.claude-3-5-haiku-20241022-v1:0
us.anthropic.claude-3-7-sonnet-20250219-v1:0
us.anthropic.claude-3-haiku-20240307-v1:0
The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.
The identifier of the model used for this AI Prompt.
", "UpdateAIPromptRequest$modelId": "The identifier of the model used for this AI Prompt.
For more information on supported models, see Supported models for system and custom prompts.
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": { } }, "ActivateMessageTemplateRequest": { "base": null, "refs": { } }, "ActivateMessageTemplateResponse": { "base": null, "refs": { } }, "AgentAttributes": { "base": "Information about an agent.
", "refs": { "MessageTemplateAttributes$agentAttributes": "The agent attributes that are used with the message template.
" } }, "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$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIAgentData$aiAgentArn": "The Amazon Resource Name (ARN) of the AI agent.
", "AIAgentSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIAgentSummary$aiAgentArn": "The Amazon Resource Name (ARN) of the AI agent.
", "AIGuardrailData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIGuardrailData$aiGuardrailArn": "The Amazon Resource Name (ARN) of the AI Guardrail.
", "AIGuardrailSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIGuardrailSummary$aiGuardrailArn": "The Amazon Resource Name (ARN) of the AI Guardrail.
", "AIPromptData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIPromptData$aiPromptArn": "The Amazon Resource Name (ARN) of the AI Prompt.
", "AIPromptSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AIPromptSummary$aiPromptArn": "The Amazon Resource Name (ARN) of the AI Prompt.
", "AssistantAssociationData$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", "AssistantAssociationData$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "AssistantAssociationSummary$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", "AssistantAssociationSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "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$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentAssociationData$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentAssociationData$contentAssociationArn": "The Amazon Resource Name (ARN) of the content association.
", "ContentAssociationSummary$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.
", "ContentData$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentReference$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ContentReference$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentSummary$contentArn": "The Amazon Resource Name (ARN) of the content.
", "ContentSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "ExtendedMessageTemplateData$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.
", "MessageTemplateData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "MessageTemplateSearchResultData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "MessageTemplateSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "MessageTemplateVersionSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseData$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "QuickResponseData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseSearchResultData$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "QuickResponseSearchResultData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "QuickResponseSummary$quickResponseArn": "The Amazon Resource Name (ARN) of the quick response.
", "QuickResponseSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", "SessionData$sessionArn": "The Amazon Resource Name (ARN) of the session.
", "SessionSummary$sessionArn": "The Amazon Resource Name (ARN) of the session.
", "SessionSummary$assistantArn": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "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.
" } }, "ArnWithQualifier": { "base": null, "refs": { "ActivateMessageTemplateResponse$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "DeactivateMessageTemplateResponse$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "ExtendedMessageTemplateData$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "MessageTemplateData$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "MessageTemplateSearchResultData$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "MessageTemplateSummary$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
", "MessageTemplateVersionSummary$messageTemplateArn": "The Amazon Resource Name (ARN) of the message template.
" } }, "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.
", "SelfServiceAIAgentConfiguration$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.
" } }, "AttachmentFileName": { "base": null, "refs": { "CreateMessageTemplateAttachmentRequest$name": "The name of the attachment file being uploaded. The name should include the file extension.
", "MessageTemplateAttachment$name": "The name of the attachment file being uploaded. The name should include the file extension.
" } }, "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.
", "ExtendedMessageTemplateData$isActive": "Whether the version of the message template is activated.
", "MessageConfiguration$generateFillerMessage": "Generates a filler response when tool selection is QUESTION.
Whether to treat null value as a match for the attribute field.
", "MessageTemplateQueryField$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.
", "MessageTemplateSearchResultData$isActive": "Whether the version of the message template is activated.
", "MessageTemplateVersionSummary$isActive": "Whether the version of the message template is activated.
", "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 to remove the grouping configuration of the quick response.
", "UpdateQuickResponseRequest$removeDescription": "Whether to remove the description from the quick response.
", "UpdateQuickResponseRequest$removeShortcutKey": "Whether to remove the shortcut key of the quick response.
", "UpdateQuickResponseRequest$isActive": "Whether the quick response is active.
" } }, "Channel": { "base": null, "refs": { "Channels$member": null } }, "ChannelSubtype": { "base": null, "refs": { "CreateMessageTemplateRequest$channelSubtype": "The channel subtype this message template applies to.
", "ExtendedMessageTemplateData$channelSubtype": "The channel subtype this message template applies to.
", "MessageTemplateData$channelSubtype": "The channel subtype this message template applies to.
", "MessageTemplateSearchResultData$channelSubtype": "The channel subtype this message template applies to.
", "MessageTemplateSummary$channelSubtype": "The channel subtype this message template applies to.
", "MessageTemplateVersionSummary$channelSubtype": "The channel subtype this message template applies to.
" } }, "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 Amazon Web Services 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 Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
", "CreateAIGuardrailRequest$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..
", "CreateAIGuardrailVersionRequest$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..
", "CreateAIPromptRequest$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..
", "CreateAIPromptVersionRequest$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..
", "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.
", "CreateMessageTemplateAttachmentRequest$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.
", "CreateMessageTemplateRequest$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.
", "SendMessageRequest$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.
", "UpdateAIAgentRequest$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..
", "UpdateAIGuardrailRequest$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..
", "UpdateAIPromptRequest$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..
" } }, "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$attributesNotInterpolated": "The user defined contact attributes that are not resolved when the search result is returned.
", "QuickResponseSearchResultData$attributesInterpolated": "The user defined contact attributes that are 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.
" } }, "ContentDisposition": { "base": null, "refs": { "CreateMessageTemplateAttachmentRequest$contentDisposition": "The presentation information for the attachment file.
", "MessageTemplateAttachment$contentDisposition": "The presentation information for the attachment file.
" } }, "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.
" } }, "ConversationContext": { "base": "The conversation context to include in SendMessage.
", "refs": { "SendMessageRequest$conversationContext": "The conversation context before the Amazon Q in Connect session.
" } }, "ConversationState": { "base": "The conversation state associated to a message.
", "refs": { "GetNextMessageResponse$conversationState": "The state of current conversation.
" } }, "ConversationStatus": { "base": null, "refs": { "ConversationState$status": "The status of the conversation state.
" } }, "ConversationStatusReason": { "base": null, "refs": { "ConversationState$reason": "The reason of the conversation state.
" } }, "CreateAIAgentRequest": { "base": null, "refs": { } }, "CreateAIAgentResponse": { "base": null, "refs": { } }, "CreateAIAgentVersionRequest": { "base": null, "refs": { } }, "CreateAIAgentVersionResponse": { "base": null, "refs": { } }, "CreateAIGuardrailRequest": { "base": null, "refs": { } }, "CreateAIGuardrailResponse": { "base": null, "refs": { } }, "CreateAIGuardrailVersionRequest": { "base": null, "refs": { } }, "CreateAIGuardrailVersionResponse": { "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": { } }, "CreateMessageTemplateAttachmentRequest": { "base": null, "refs": { } }, "CreateMessageTemplateAttachmentResponse": { "base": null, "refs": { } }, "CreateMessageTemplateRequest": { "base": null, "refs": { } }, "CreateMessageTemplateResponse": { "base": null, "refs": { } }, "CreateMessageTemplateVersionRequest": { "base": null, "refs": { } }, "CreateMessageTemplateVersionResponse": { "base": null, "refs": { } }, "CreateQuickResponseRequest": { "base": null, "refs": { } }, "CreateQuickResponseResponse": { "base": null, "refs": { } }, "CreateSessionRequest": { "base": null, "refs": { } }, "CreateSessionResponse": { "base": null, "refs": { } }, "CustomAttributes": { "base": null, "refs": { "CustomerProfileAttributes$custom": "The custom attributes in customer profile attributes.
", "MessageTemplateAttributes$customAttributes": "The custom attributes that are used with the message template.
" } }, "CustomerProfileAttributes": { "base": "The customer profile attributes that are used with the message template.
", "refs": { "MessageTemplateAttributes$customerProfileAttributes": "The customer profile attributes that are used with the message template.
" } }, "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": { "GenerativeChunkDataDetails$references": "The references used to generate the LLM response.
", "GenerativeDataDetails$references": "The references used to generative the LLM response.
" } }, "DeactivateMessageTemplateRequest": { "base": null, "refs": { } }, "DeactivateMessageTemplateResponse": { "base": null, "refs": { } }, "DeleteAIAgentRequest": { "base": null, "refs": { } }, "DeleteAIAgentResponse": { "base": null, "refs": { } }, "DeleteAIAgentVersionRequest": { "base": null, "refs": { } }, "DeleteAIAgentVersionResponse": { "base": null, "refs": { } }, "DeleteAIGuardrailRequest": { "base": null, "refs": { } }, "DeleteAIGuardrailResponse": { "base": null, "refs": { } }, "DeleteAIGuardrailVersionRequest": { "base": null, "refs": { } }, "DeleteAIGuardrailVersionResponse": { "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": { } }, "DeleteMessageTemplateAttachmentRequest": { "base": null, "refs": { } }, "DeleteMessageTemplateAttachmentResponse": { "base": null, "refs": { } }, "DeleteMessageTemplateRequest": { "base": null, "refs": { } }, "DeleteMessageTemplateResponse": { "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.
", "CreateMessageTemplateRequest$description": "The description of the message template.
", "CreateSessionRequest$description": "The description.
", "ExtendedMessageTemplateData$description": "The description of the message template.
", "KnowledgeBaseData$description": "The description.
", "KnowledgeBaseSummary$description": "The description of the knowledge base.
", "MessageTemplateData$description": "The description of the message template.
", "MessageTemplateSearchResultData$description": "The description of the message template.
", "MessageTemplateSummary$description": "The description of the message template.
", "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.
", "UpdateMessageTemplateMetadataRequest$description": "The description of the message template.
", "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$title": "The title of the document.
", "Document$excerpt": "The excerpt from the document.
", "TextData$title": null, "TextData$excerpt": null } }, "EmailHeader": { "base": "The email header to include in email messages.
", "refs": { "EmailHeaders$member": null } }, "EmailHeaderKey": { "base": null, "refs": { "EmailHeader$name": "The name of the email header.
" } }, "EmailHeaderValue": { "base": null, "refs": { "EmailHeader$value": "The value of the email header.
" } }, "EmailHeaders": { "base": null, "refs": { "EmailMessageTemplateContent$headers": "The email headers to include in email messages.
" } }, "EmailMessageTemplateContent": { "base": "The content of the message template that applies to the email channel subtype.
", "refs": { "MessageTemplateContentProvider$email": "The content of the message template that applies to the email channel subtype.
" } }, "EmailMessageTemplateContentBody": { "base": "The body to use in email messages.
", "refs": { "EmailMessageTemplateContent$body": "The body to use in email messages.
" } }, "ExtendedMessageTemplateData": { "base": "The extended data of a message template.
", "refs": { "CreateMessageTemplateVersionResponse$messageTemplate": "The message template.
", "GetMessageTemplateResponse$messageTemplate": "The message template.
" } }, "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.
" } }, "GenerativeChunkDataDetails": { "base": "Details about the generative chunk data.
", "refs": { "DataDetails$generativeChunkData": "Details about the generative chunk data.
" } }, "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.
", "ExtendedMessageTemplateData$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the message template data.
", "MessageTemplateData$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the message template data.
", "MessageTemplateSearchResultData$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the message template data.
", "MessageTemplateSummary$lastModifiedBy": "The Amazon Resource Name (ARN) of the user who last updated the message template data.
", "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": { } }, "GetAIGuardrailRequest": { "base": null, "refs": { } }, "GetAIGuardrailResponse": { "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": { } }, "GetMessageTemplateRequest": { "base": null, "refs": { } }, "GetMessageTemplateResponse": { "base": null, "refs": { } }, "GetNextMessageRequest": { "base": null, "refs": { } }, "GetNextMessageResponse": { "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": { "CreateMessageTemplateRequest$groupingConfiguration": null, "CreateQuickResponseRequest$groupingConfiguration": "The configuration information of the user groups that the quick response is accessible to.
", "ExtendedMessageTemplateData$groupingConfiguration": null, "MessageTemplateData$groupingConfiguration": null, "MessageTemplateSearchResultData$groupingConfiguration": null, "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.
", "UpdateMessageTemplateMetadataRequest$groupingConfiguration": null, "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.
Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
Hate: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
", "refs": { "GuardrailContentFiltersConfig$member": null } }, "GuardrailContentFilterType": { "base": "Type of text to text filter in content policy
", "refs": { "GuardrailContentFilterConfig$type": "The harmful category that the content filter is applied to.
" } }, "GuardrailContentFiltersConfig": { "base": "List of content filter configs in content policy.
", "refs": { "AIGuardrailContentPolicyConfig$filtersConfig": "Contains the type of the content filter and how strongly it should apply to prompts and model responses.
" } }, "GuardrailContextualGroundingFilterConfig": { "base": "The filter configuration details for the AI Guardrail's contextual grounding filter.
", "refs": { "GuardrailContextualGroundingFiltersConfig$member": null } }, "GuardrailContextualGroundingFilterThreshold": { "base": "The threshold for this filter.
", "refs": { "GuardrailContextualGroundingFilterConfig$threshold": "The threshold details for the AI Guardrail's contextual grounding filter.
" } }, "GuardrailContextualGroundingFilterType": { "base": "Type of contextual grounding filter
", "refs": { "GuardrailContextualGroundingFilterConfig$type": "The filter type for the AI Guardrail's contextual grounding filter.
" } }, "GuardrailContextualGroundingFiltersConfig": { "base": "List of contextual grounding filter configs.
", "refs": { "AIGuardrailContextualGroundingPolicyConfig$filtersConfig": "The filter configuration details for the AI Guardrails contextual grounding policy.
" } }, "GuardrailFilterStrength": { "base": "Strength for filters
", "refs": { "GuardrailContentFilterConfig$inputStrength": "The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
", "GuardrailContentFilterConfig$outputStrength": "The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
" } }, "GuardrailManagedWordListsConfig": { "base": "A config for the list of managed words.
", "refs": { "AIGuardrailWordPolicyConfig$managedWordListsConfig": "A list of managed words to configure for the AI Guardrail.
" } }, "GuardrailManagedWordsConfig": { "base": "The managed word list to configure for the AI Guardrail.
", "refs": { "GuardrailManagedWordListsConfig$member": null } }, "GuardrailManagedWordsType": { "base": "Options for managed words.
", "refs": { "GuardrailManagedWordsConfig$type": "The managed word type to configure for the AI Guardrail.
" } }, "GuardrailPiiEntitiesConfig": { "base": "List of entities.
", "refs": { "AIGuardrailSensitiveInformationPolicyConfig$piiEntitiesConfig": "A list of PII entities to configure to the AI Guardrail.
" } }, "GuardrailPiiEntityConfig": { "base": "The PII entity to configure for the AI Guardrail.
", "refs": { "GuardrailPiiEntitiesConfig$member": null } }, "GuardrailPiiEntityType": { "base": "The currently supported PII entities
", "refs": { "GuardrailPiiEntityConfig$type": "Configure AI Guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
General
ADDRESS
A physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
AGE
An individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guarrails recognizes \"40 years\" as an age.
NAME
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.
An email address, such as marymajor@email.com.
PHONE
A phone number. This entity type also includes fax and pager numbers.
USERNAME
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
PASSWORD
An alphanumeric string that is used as a password, such as \"* very20special#pass*\".
DRIVER_ID
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
LICENSE_PLATE
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
VEHICLE_IDENTIFICATION_NUMBER
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
Finance
CREDIT_DEBIT_CARD_CVV
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
CREDIT_DEBIT_CARD_EXPIRY
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. AI Guardrail recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
CREDIT_DEBIT_CARD_NUMBER
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
PIN
A four-digit personal identification number (PIN) with which you can access your bank account.
INTERNATIONAL_BANK_ACCOUNT_NUMBER
An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.
SWIFT_CODE
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
IT
IP_ADDRESS
An IPv4 address, such as 198.51.100.0.
MAC_ADDRESS
A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).
URL
A web address, such as www.example.com.
AWS_ACCESS_KEY
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
AWS_SECRET_KEY
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
USA specific
US_BANK_ACCOUNT_NUMBER
A US bank account number, which is typically 10 to 12 digits long.
US_BANK_ROUTING_NUMBER
A US bank account routing number. These are typically nine digits long,
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
US_PASSPORT_NUMBER
A US passport number. Passport numbers range from six to nine alphanumeric characters.
US_SOCIAL_SECURITY_NUMBER
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
Canada specific
CA_HEALTH_NUMBER
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
CA_SOCIAL_INSURANCE_NUMBER
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm .
UK Specific
UK_NATIONAL_HEALTH_SERVICE_NUMBER
A UK National Health Service Number is a 10-17 digit number, such as 485 555 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
UK_NATIONAL_INSURANCE_NUMBER
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
Custom
Regex filter - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..
The regular expression to configure for the AI Guardrail.
", "refs": { "GuardrailRegexesConfig$member": null } }, "GuardrailRegexDescription": { "base": "The regex description.
", "refs": { "GuardrailRegexConfig$description": "The description of the regular expression to configure for the AI Guardrail.
" } }, "GuardrailRegexName": { "base": "The regex name.
", "refs": { "GuardrailRegexConfig$name": "The name of the regular expression to configure for the AI Guardrail.
" } }, "GuardrailRegexPattern": { "base": "The regex pattern.
", "refs": { "GuardrailRegexConfig$pattern": "The regular expression pattern to configure for the AI Guardrail.
" } }, "GuardrailRegexesConfig": { "base": "List of regex.
", "refs": { "AIGuardrailSensitiveInformationPolicyConfig$regexesConfig": "A list of regular expressions to configure to the AI Guardrail.
" } }, "GuardrailSensitiveInformationAction": { "base": "Options for sensitive information action.
", "refs": { "GuardrailPiiEntityConfig$action": "Configure AI Guardrail's action when the PII entity is detected.
", "GuardrailRegexConfig$action": "The AI Guardrail action to configure when matching regular expression is detected.
" } }, "GuardrailTopicConfig": { "base": "Details about topics for the AI Guardrail to identify and deny.
", "refs": { "GuardrailTopicsConfig$member": null } }, "GuardrailTopicDefinition": { "base": "Definition of topic in topic policy
", "refs": { "GuardrailTopicConfig$definition": "A definition of the topic to deny.
" } }, "GuardrailTopicExample": { "base": "Text example in topic policy
", "refs": { "GuardrailTopicExamples$member": null } }, "GuardrailTopicExamples": { "base": "List of text examples
", "refs": { "GuardrailTopicConfig$examples": "A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" } }, "GuardrailTopicName": { "base": "Name of topic in topic policy
", "refs": { "GuardrailTopicConfig$name": "The name of the topic to deny.
" } }, "GuardrailTopicType": { "base": "Type of topic in a policy
", "refs": { "GuardrailTopicConfig$type": "Specifies to deny the topic.
" } }, "GuardrailTopicsConfig": { "base": "List of topic configs in topic policy.
", "refs": { "AIGuardrailTopicPolicyConfig$topicsConfig": "A list of policies related to topics that the AI Guardrail should deny.
" } }, "GuardrailWordConfig": { "base": "A word to configure for the AI Guardrail.
", "refs": { "GuardrailWordsConfig$member": null } }, "GuardrailWordText": { "base": "The custom word text.
", "refs": { "GuardrailWordConfig$text": "Text of the word configured for the AI Guardrail to block.
" } }, "GuardrailWordsConfig": { "base": "List of custom word configs.
", "refs": { "AIGuardrailWordPolicyConfig$wordsConfig": "A list of words to configure for the AI Guardrail.
" } }, "Headers": { "base": null, "refs": { "StartContentUploadResponse$headersToInclude": "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.
The number of turn of the conversation history data.
" } }, "IntentDetectedDataDetails": { "base": "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": { "CreateMessageTemplateRequest$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. 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. 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. 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. 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. 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.
", "UpdateMessageTemplateRequest$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. 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.
", "ListAIGuardrailVersionsRequest$maxResults": "The maximum number of results to return per page.
", "ListAIGuardrailsRequest$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.
", "ListMessageTemplateVersionsRequest$maxResults": "The maximum number of results to return per page.
", "ListMessageTemplatesRequest$maxResults": "The maximum number of results to return per page.
", "ListMessagesRequest$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.
", "SearchMessageTemplatesRequest$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.
" } }, "MessageConfiguration": { "base": "The configuration for a SendMessage request.
", "refs": { "SendMessageRequest$configuration": "The configuration of the SendMessage request.
", "SendMessageResponse$configuration": "The configuration of the SendMessage request.
" } }, "MessageData": { "base": "The message data.
", "refs": { "MessageInput$value": "The message input value.
", "MessageOutput$value": "The value of a message data.
" } }, "MessageInput": { "base": "The message input.
", "refs": { "SendMessageRequest$message": "The message data to submit to the Amazon Q in Connect session.
" } }, "MessageList": { "base": null, "refs": { "ListMessagesResponse$messages": "The message information.
" } }, "MessageOutput": { "base": "The message output.
", "refs": { "GetNextMessageResponse$response": "The message response to the requested message.
", "MessageList$member": null } }, "MessageTemplateAttachment": { "base": "Information about the message template attachment.
", "refs": { "CreateMessageTemplateAttachmentResponse$attachment": "The message template attachment.
", "MessageTemplateAttachmentList$member": null } }, "MessageTemplateAttachmentList": { "base": null, "refs": { "ExtendedMessageTemplateData$attachments": "The message template attachments.
", "RenderMessageTemplateResponse$attachments": "The message template attachments.
" } }, "MessageTemplateAttributeKey": { "base": null, "refs": { "CustomAttributes$key": null, "MessageTemplateAttributeKeyList$member": null } }, "MessageTemplateAttributeKeyList": { "base": null, "refs": { "RenderMessageTemplateResponse$attributesNotInterpolated": "The attribute keys that are not resolved.
" } }, "MessageTemplateAttributeType": { "base": null, "refs": { "MessageTemplateAttributeTypeList$member": null } }, "MessageTemplateAttributeTypeList": { "base": null, "refs": { "ExtendedMessageTemplateData$attributeTypes": "The types of attributes contain the message template.
", "MessageTemplateData$attributeTypes": "The types of attributes that the message template contains.
" } }, "MessageTemplateAttributeValue": { "base": null, "refs": { "AgentAttributes$firstName": "The agent’s first name as entered in their Amazon Connect user account.
", "AgentAttributes$lastName": "The agent’s last name as entered in their Amazon Connect user account.
", "CustomAttributes$value": null, "CustomerProfileAttributes$profileId": "The unique identifier of a customer profile.
", "CustomerProfileAttributes$profileARN": "The ARN of a customer profile.
", "CustomerProfileAttributes$firstName": "The customer's first name.
", "CustomerProfileAttributes$middleName": "The customer's middle name.
", "CustomerProfileAttributes$lastName": "The customer's last name.
", "CustomerProfileAttributes$accountNumber": "A unique account number that you have given to the customer.
", "CustomerProfileAttributes$emailAddress": "The customer's email address, which has not been specified as a personal or business address.
", "CustomerProfileAttributes$phoneNumber": "The customer's phone number, which has not been specified as a mobile, home, or business number.
", "CustomerProfileAttributes$additionalInformation": "Any additional information relevant to the customer's profile.
", "CustomerProfileAttributes$partyType": "The customer's party type.
", "CustomerProfileAttributes$businessName": "The name of the customer's business.
", "CustomerProfileAttributes$birthDate": "The customer's birth date.
", "CustomerProfileAttributes$gender": "The customer's gender.
", "CustomerProfileAttributes$mobilePhoneNumber": "The customer's mobile phone number.
", "CustomerProfileAttributes$homePhoneNumber": "The customer's mobile phone number.
", "CustomerProfileAttributes$businessPhoneNumber": "The customer's business phone number.
", "CustomerProfileAttributes$businessEmailAddress": "The customer's business email address.
", "CustomerProfileAttributes$address1": "The first line of a customer address.
", "CustomerProfileAttributes$address2": "The second line of a customer address.
", "CustomerProfileAttributes$address3": "The third line of a customer address.
", "CustomerProfileAttributes$address4": "The fourth line of a customer address.
", "CustomerProfileAttributes$city": "The city in which a customer lives.
", "CustomerProfileAttributes$county": "The county in which a customer lives.
", "CustomerProfileAttributes$country": "The country in which a customer lives.
", "CustomerProfileAttributes$postalCode": "The postal code of a customer address.
", "CustomerProfileAttributes$province": "The province in which a customer lives.
", "CustomerProfileAttributes$state": "The state in which a customer lives.
", "CustomerProfileAttributes$shippingAddress1": "The first line of a customer’s shipping address.
", "CustomerProfileAttributes$shippingAddress2": "The second line of a customer’s shipping address.
", "CustomerProfileAttributes$shippingAddress3": "The third line of a customer’s shipping address.
", "CustomerProfileAttributes$shippingAddress4": "The fourth line of a customer’s shipping address.
", "CustomerProfileAttributes$shippingCity": "The city of a customer’s shipping address.
", "CustomerProfileAttributes$shippingCounty": "The county of a customer’s shipping address.
", "CustomerProfileAttributes$shippingCountry": "The country of a customer’s shipping address.
", "CustomerProfileAttributes$shippingPostalCode": "The postal code of a customer’s shipping address.
", "CustomerProfileAttributes$shippingProvince": "The province of a customer’s shipping address.
", "CustomerProfileAttributes$shippingState": "The state of a customer’s shipping address.
", "CustomerProfileAttributes$mailingAddress1": "The first line of a customer’s mailing address.
", "CustomerProfileAttributes$mailingAddress2": "The second line of a customer’s mailing address.
", "CustomerProfileAttributes$mailingAddress3": "The third line of a customer’s mailing address.
", "CustomerProfileAttributes$mailingAddress4": "The fourth line of a customer’s mailing address.
", "CustomerProfileAttributes$mailingCity": "The city of a customer’s mailing address.
", "CustomerProfileAttributes$mailingCounty": "The county of a customer’s mailing address.
", "CustomerProfileAttributes$mailingCountry": "The country of a customer’s mailing address.
", "CustomerProfileAttributes$mailingPostalCode": "The postal code of a customer’s mailing address.
", "CustomerProfileAttributes$mailingProvince": "The province of a customer’s mailing address.
", "CustomerProfileAttributes$mailingState": "The state of a customer’s mailing address.
", "CustomerProfileAttributes$billingAddress1": "The first line of a customer’s billing address.
", "CustomerProfileAttributes$billingAddress2": "The second line of a customer’s billing address.
", "CustomerProfileAttributes$billingAddress3": "The third line of a customer’s billing address.
", "CustomerProfileAttributes$billingAddress4": "The fourth line of a customer’s billing address.
", "CustomerProfileAttributes$billingCity": "The city of a customer’s billing address.
", "CustomerProfileAttributes$billingCounty": "The county of a customer’s billing address.
", "CustomerProfileAttributes$billingCountry": "The country of a customer’s billing address.
", "CustomerProfileAttributes$billingPostalCode": "The postal code of a customer’s billing address.
", "CustomerProfileAttributes$billingProvince": "The province of a customer’s billing address.
", "CustomerProfileAttributes$billingState": "The state of a customer’s billing address.
", "SystemAttributes$name": "The name of the task.
", "SystemEndpointAttributes$address": "The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
The attributes that are used with the message template.
", "refs": { "CreateMessageTemplateRequest$defaultAttributes": "An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
", "ExtendedMessageTemplateData$defaultAttributes": "An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
", "MessageTemplateData$defaultAttributes": "An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
", "RenderMessageTemplateRequest$attributes": "An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.
", "UpdateMessageTemplateRequest$defaultAttributes": "An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
" } }, "MessageTemplateBodyContentProvider": { "base": "The container of the message template body.
", "refs": { "EmailMessageTemplateContentBody$plainText": "The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
", "EmailMessageTemplateContentBody$html": "The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
", "SMSMessageTemplateContentBody$plainText": "The message body to use in SMS messages.
" } }, "MessageTemplateContentProvider": { "base": "The container of message template content.
", "refs": { "CreateMessageTemplateRequest$content": "The content of the message template.
", "ExtendedMessageTemplateData$content": "The content of the message template.
", "MessageTemplateData$content": "The content of the message template.
", "RenderMessageTemplateResponse$content": "The content of the message template.
", "UpdateMessageTemplateRequest$content": "The content of the message template.
" } }, "MessageTemplateContentSha256": { "base": null, "refs": { "CreateMessageTemplateVersionRequest$messageTemplateContentSha256": "The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the $LATEST qualifier by default.
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
The data of a message template.
", "refs": { "CreateMessageTemplateResponse$messageTemplate": "The message template.
", "UpdateMessageTemplateMetadataResponse$messageTemplate": "The message template.
", "UpdateMessageTemplateResponse$messageTemplate": "The message template.
" } }, "MessageTemplateFilterField": { "base": "The message template fields to filter the message template query results by. The following is the list of supported field names:
name
description
channel
channelSubtype
language
qualifier
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
The configuration of filtering rules applied to message template query results.
" } }, "MessageTemplateFilterOperator": { "base": null, "refs": { "MessageTemplateFilterField$operator": "The operator to use for filtering.
" } }, "MessageTemplateFilterValue": { "base": null, "refs": { "MessageTemplateFilterValueList$member": null } }, "MessageTemplateFilterValueList": { "base": null, "refs": { "MessageTemplateFilterField$values": "The values of attribute field to filter the message template by.
" } }, "MessageTemplateOrderField": { "base": "The message template fields to order the message template query results by. The following is the list of supported field names:
name
description
channel
channelSubtype
language
qualifier
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
The message template attribute fields on which the query results are ordered.
" } }, "MessageTemplateQueryField": { "base": "The message template fields to query message templates by. The following is the list of supported field names:
name
description
The message template query expressions.
" } }, "MessageTemplateQueryOperator": { "base": null, "refs": { "MessageTemplateQueryField$operator": "The operator to use for matching attribute field values in the query.
" } }, "MessageTemplateQueryValue": { "base": null, "refs": { "MessageTemplateQueryValueList$member": null } }, "MessageTemplateQueryValueList": { "base": null, "refs": { "MessageTemplateQueryField$values": "The values of the attribute to query the message templates by.
" } }, "MessageTemplateSearchExpression": { "base": "The search expression of the message template.
", "refs": { "SearchMessageTemplatesRequest$searchExpression": "The search expression for querying the message template.
" } }, "MessageTemplateSearchResultData": { "base": "The result of message template search.
", "refs": { "MessageTemplateSearchResultsList$member": null } }, "MessageTemplateSearchResultsList": { "base": null, "refs": { "SearchMessageTemplatesResponse$results": "The results of the message template search.
" } }, "MessageTemplateSummary": { "base": "The summary of the message template.
", "refs": { "MessageTemplateSummaryList$member": null } }, "MessageTemplateSummaryList": { "base": null, "refs": { "ListMessageTemplatesResponse$messageTemplateSummaries": "Summary information about the message template.
" } }, "MessageTemplateVersionSummary": { "base": "The summary of the message template version.
", "refs": { "MessageTemplateVersionSummaryList$member": null } }, "MessageTemplateVersionSummaryList": { "base": null, "refs": { "ListMessageTemplateVersionsResponse$messageTemplateVersionSummaries": "Summary information about the versions of a message template.
" } }, "MessageType": { "base": null, "refs": { "GetNextMessageResponse$type": "The type of message response.
", "SendMessageRequest$type": "The message type.
" } }, "Name": { "base": null, "refs": { "AIAgentData$name": "The name of the AI Agent.
", "AIAgentSummary$name": "The name of the AI Agent.
", "AIGuardrailData$name": "The name of the AI Guardrail.
", "AIGuardrailSummary$name": "The name of the AI Guardrail.
", "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.
", "CreateAIGuardrailRequest$name": "The name of the AI Guardrail.
", "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.
", "CreateMessageTemplateRequest$name": "The name of the message template.
", "CreateSessionRequest$name": "The name of the session.
", "ExtendedMessageTemplateData$name": "The name of the message template.
", "KnowledgeBaseData$name": "The name of the knowledge base.
", "KnowledgeBaseSummary$name": "The name of the knowledge base.
", "MessageTemplateData$name": "The name of the message template.
", "MessageTemplateSearchResultData$name": "The name of the message template.
", "MessageTemplateSummary$name": "The name of the message template.
", "MessageTemplateVersionSummary$name": "The name of the message template.
", "SessionData$name": "The name of the session.
", "UpdateMessageTemplateMetadataRequest$name": "The name of the message template.
" } }, "NextToken": { "base": null, "refs": { "GenerativeChunkDataDetails$nextChunkToken": "The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
", "GetNextMessageRequest$nextMessageToken": "The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.
", "GetNextMessageResponse$nextMessageToken": "The token for the next message.
", "GetRecommendationsRequest$nextChunkToken": "The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.
", "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.
", "ListAIGuardrailVersionsRequest$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.
", "ListAIGuardrailVersionsResponse$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.
", "ListAIGuardrailsRequest$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.
", "ListAIGuardrailsResponse$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.
", "ListMessageTemplateVersionsRequest$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.
", "ListMessageTemplateVersionsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListMessageTemplatesRequest$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.
", "ListMessageTemplatesResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", "ListMessagesRequest$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.
", "ListMessagesResponse$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.
", "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.
", "SearchMessageTemplatesRequest$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.
", "SearchMessageTemplatesResponse$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.
", "SendMessageResponse$nextMessageToken": "The token for the next message, used by GetNextMessage.
" } }, "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": { "AnswerRecommendationAIAgentConfiguration$locale": "The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
For more information on supported locales, see Language support for Amazon Q in Connect.
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.
", "ManualSearchAIAgentConfiguration$locale": "The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
For more information on supported locales, see Language support for Amazon Q in Connect.
The name of the attribute field to filter the message templates by.
", "MessageTemplateOrderField$name": "The name of the message template.
", "MessageTemplateQueryField$name": "The name of the attribute to query the message templates by.
", "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.
The body of the attachment file being uploaded. It should be encoded using base64 encoding.
", "EmailMessageTemplateContent$subject": "The subject line, or title, to use in email messages.
", "MessageTemplateBodyContentProvider$content": "The content of the message template.
" } }, "NotifyRecommendationsReceivedError": { "base": "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 message templates are sorted by.
", "QuickResponseOrderField$order": "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.
The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
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.
" } }, "Participant": { "base": null, "refs": { "MessageOutput$participant": "The participant of a message.
" } }, "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.
", "QuickResponseQueryField$priority": "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$plainText": null, "QuickResponseContents$markdown": 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": { } }, "RenderMessageTemplateRequest": { "base": null, "refs": { } }, "RenderMessageTemplateResponse": { "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": { "GetNextMessageResponse$conversationSessionData": "The conversation data stored on an Amazon Q in Connect Session.
", "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.
" } }, "SMSMessageTemplateContent": { "base": "The content of the message template that applies to the SMS channel subtype.
", "refs": { "MessageTemplateContentProvider$sms": "The content of the message template that applies to the SMS channel subtype.
" } }, "SMSMessageTemplateContentBody": { "base": "The body to use in SMS messages.
", "refs": { "SMSMessageTemplateContent$body": "The body to use in SMS messages.
" } }, "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.
" } }, "SearchMessageTemplatesRequest": { "base": null, "refs": { } }, "SearchMessageTemplatesResponse": { "base": null, "refs": { } }, "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.
" } }, "SelfServiceAIAgentConfiguration": { "base": "The configuration for AI Agents of type SELF_SERVICE.
", "refs": { "AIAgentConfiguration$selfServiceAIAgentConfiguration": "The configuration for AI Agents of type SELF_SERVICE.
" } }, "SelfServiceConversationHistory": { "base": "The conversation history data to included in conversation context data before the Amazon Q in Connect session.
", "refs": { "SelfServiceConversationHistoryList$member": null } }, "SelfServiceConversationHistoryList": { "base": null, "refs": { "ConversationContext$selfServiceConversationHistory": "The self service conversation history before the Amazon Q in Connect session.
" } }, "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.
" } }, "SendMessageRequest": { "base": null, "refs": { } }, "SendMessageResponse": { "base": null, "refs": { } }, "SensitiveString": { "base": null, "refs": { "DocumentText$text": "Text in the document.
", "GenerativeChunkDataDetails$completion": "A chunk of the LLM response.
", "GenerativeDataDetails$completion": "The LLM response.
", "IntentDetectedDataDetails$intent": "The detected intent.
", "SelfServiceConversationHistory$inputTranscript": "The input transcript of the conversation history data.
", "SelfServiceConversationHistory$botResponse": "The bot response of the conversation history data.
" } }, "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 or Managed 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.
", "AIGuardrailData$status": "The status of the AI Guardrail.
", "AIGuardrailSummary$status": "The status of the AI Guardrail.
", "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.
", "UnauthorizedException$message": null, "ValidationException$message": null } }, "SyncStatus": { "base": null, "refs": { "KnowledgeBaseData$ingestionStatus": "Status of ingestion on data source.
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "ExtendedMessageTemplateData$createdTime": "The timestamp when the message template was created.
", "ExtendedMessageTemplateData$lastModifiedTime": "The timestamp when the message template data was last modified.
", "MessageTemplateAttachment$uploadedTime": "The timestamp when the attachment file was uploaded.
", "MessageTemplateAttachment$urlExpiry": "The expiration time of the pre-signed Amazon S3 URL.
", "MessageTemplateData$createdTime": "The timestamp when the message template was created.
", "MessageTemplateData$lastModifiedTime": "The timestamp when the message template data was last modified.
", "MessageTemplateSearchResultData$createdTime": "The timestamp when the message template was created.
", "MessageTemplateSearchResultData$lastModifiedTime": "The timestamp when the message template data was last modified.
", "MessageTemplateSummary$createdTime": "The timestamp when the message template was created.
", "MessageTemplateSummary$lastModifiedTime": "The timestamp when the message template data was last modified.
" } }, "SyntheticTimestamp_epoch_seconds": { "base": null, "refs": { "ContentData$urlExpiry": "The expiration time of the URL as an epoch timestamp.
", "ImportJobData$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.
", "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.
" } }, "SystemAttributes": { "base": "The system attributes that are used with the message template.
", "refs": { "MessageTemplateAttributes$systemAttributes": "The system attributes that are used with the message template.
" } }, "SystemEndpointAttributes": { "base": "The system endpoint attributes that are used with the message template.
", "refs": { "SystemAttributes$customerEndpoint": "The CustomerEndpoint attribute.
", "SystemAttributes$systemEndpoint": "The SystemEndpoint attribute.
" } }, "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.
", "AIGuardrailData$tags": "The tags used to organize, track, or control access for this resource.
", "AIGuardrailSummary$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.
", "CreateAIGuardrailRequest$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.
", "CreateMessageTemplateRequest$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.
", "ExtendedMessageTemplateData$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.
", "MessageTemplateData$tags": "The tags used to organize, track, or control access for this resource.
", "MessageTemplateSearchResultData$tags": "The tags used to organize, track, or control access for this resource.
", "MessageTemplateSummary$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.
" } }, "TextMessage": { "base": "The message data in text type.
", "refs": { "MessageData$text": "The message data in text type.
" } }, "TextMessageValueString": { "base": null, "refs": { "TextMessage$value": "The value of the message data in text type.
" } }, "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.
", "AIGuardrailData$modifiedTime": "The time the AI Guardrail was last modified.
", "AIGuardrailSummary$modifiedTime": "The time the AI Guardrail 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.
", "CreateAIGuardrailVersionRequest$modifiedTime": "The time the AI Guardrail was last modified.
", "CreateAIPromptVersionRequest$modifiedTime": "The time the AI Prompt was last modified.
", "MessageOutput$timestamp": "The timestamp of a message.
" } }, "TooManyTagsException": { "base": "Amazon Q in Connect throws this exception if you have too many tags in your tag set.
", "refs": { } }, "UnauthorizedException": { "base": "You do not have permission to perform this action.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAIAgentRequest": { "base": null, "refs": { } }, "UpdateAIAgentResponse": { "base": null, "refs": { } }, "UpdateAIGuardrailRequest": { "base": null, "refs": { } }, "UpdateAIGuardrailResponse": { "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": { } }, "UpdateMessageTemplateMetadataRequest": { "base": null, "refs": { } }, "UpdateMessageTemplateMetadataResponse": { "base": null, "refs": { } }, "UpdateMessageTemplateRequest": { "base": null, "refs": { } }, "UpdateMessageTemplateResponse": { "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$url": "The download link to the resource file that is uploaded to the import job.
", "ImportJobData$failedRecordReport": "The link to download the information of resource data that failed to be imported.
", "MessageTemplateAttachment$url": "A pre-signed Amazon S3 URL that can be used to download the attachment file.
", "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$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.
", "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.
" } }, "UrlFilterPattern": { "base": null, "refs": { "UrlFilterList$member": null } }, "Uuid": { "base": null, "refs": { "AIAgentData$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIAgentData$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.
", "AIAgentSummary$aiAgentId": "The identifier of the AI Agent.
", "AIGuardrailData$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIGuardrailData$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "AIGuardrailSummary$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "AIGuardrailSummary$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "AIPromptData$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.
", "AIPromptSummary$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.
", "ActivateMessageTemplateResponse$messageTemplateId": "The identifier of the message template.
", "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$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentAssociationData$contentId": "The identifier of the content.
", "ContentAssociationData$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ContentAssociationSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentAssociationSummary$contentId": "The identifier of the content.
", "ContentAssociationSummary$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ContentData$contentId": "The identifier of the content.
", "ContentData$knowledgeBaseId": "The identifier of the knowledge base.
", "ContentReference$knowledgeBaseId": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", "ContentReference$contentId": "The identifier of the content.
", "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.
", "DeactivateMessageTemplateResponse$messageTemplateId": "The identifier of the message template.
", "DeleteImportJobRequest$importJobId": "The identifier of the import job to be deleted.
", "DeleteMessageTemplateAttachmentRequest$attachmentId": "The identifier of the attachment file.
", "ExtendedMessageTemplateData$messageTemplateId": "The identifier of the message template.
", "ExtendedMessageTemplateData$knowledgeBaseId": "The identifier of the knowledge base.
", "GenerativeReference$generationId": "The identifier of the LLM model.
", "GetImportJobRequest$importJobId": "The identifier of the import job to retrieve.
", "GetNextMessageResponse$requestMessageId": "The identifier of the submitted message.
", "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.
", "MessageOutput$messageId": "The identifier of a message.
", "MessageTemplateAttachment$attachmentId": "The identifier of the attachment file.
", "MessageTemplateData$messageTemplateId": "The identifier of the message template.
", "MessageTemplateData$knowledgeBaseId": "The identifier of the knowledge base.
", "MessageTemplateSearchResultData$messageTemplateId": "The identifier of the message template.
", "MessageTemplateSearchResultData$knowledgeBaseId": "The identifier of the knowledge base.
", "MessageTemplateSummary$messageTemplateId": "The identifier of the message template.
", "MessageTemplateSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "MessageTemplateVersionSummary$messageTemplateId": "The identifier of the message template.
", "MessageTemplateVersionSummary$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$quickResponseId": "The identifier of the quick response.
", "QuickResponseData$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.
", "QuickResponseSearchResultData$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "QuickResponseSummary$quickResponseId": "The identifier of the quick response.
", "QuickResponseSummary$knowledgeBaseId": "The identifier of the knowledge base.
", "RecommendationTrigger$id": "The identifier of the recommendation trigger.
", "ResultData$resultId": "The identifier of the result data.
", "SendMessageResponse$requestMessageId": "The identifier of the submitted message.
", "SessionData$sessionId": "The identifier of the session.
", "SessionSummary$sessionId": "The identifier of the session.
", "SessionSummary$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "SourceContentDataDetails$id": "The identifier of the source content.
", "UpdateSessionDataResponse$sessionId": "The identifier of the session.
" } }, "UuidOrArn": { "base": null, "refs": { "ActivateMessageTemplateRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "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.
", "CreateAIGuardrailRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateAIGuardrailVersionRequest$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$knowledgeBaseId": "The identifier of the knowledge base.
", "CreateContentAssociationRequest$contentId": "The identifier of the content.
", "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.
", "CreateMessageTemplateAttachmentRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateMessageTemplateRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "CreateMessageTemplateVersionRequest$knowledgeBaseId": "The identifier of the 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.
", "DeactivateMessageTemplateRequest$knowledgeBaseId": "The identifier of the knowledge base. 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.
", "DeleteAIGuardrailRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIGuardrailVersionRequest$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$knowledgeBaseId": "The identifier of the knowledge base.
", "DeleteContentAssociationRequest$contentId": "The identifier of the content.
", "DeleteContentAssociationRequest$contentAssociationId": "The identifier of the content association. 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.
", "DeleteContentRequest$contentId": "The identifier of the content. 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.
", "DeleteMessageTemplateAttachmentRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteMessageTemplateRequest$knowledgeBaseId": "The identifier of the knowledge base. 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.
", "GetAIGuardrailRequest$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$knowledgeBaseId": "The identifier of the knowledge base.
", "GetContentAssociationRequest$contentId": "The identifier of the content.
", "GetContentAssociationRequest$contentAssociationId": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "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.
", "GetMessageTemplateRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "GetNextMessageRequest$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "GetNextMessageRequest$sessionId": "The identifier of the Amazon Q in Connect session.
", "GetQuickResponseRequest$quickResponseId": "The identifier of the quick response.
", "GetQuickResponseRequest$knowledgeBaseId": "The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
", "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.
", "ListAIGuardrailVersionsRequest$assistantId": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListAIGuardrailsRequest$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$knowledgeBaseId": "The identifier of the knowledge base.
", "ListContentAssociationsRequest$contentId": "The identifier of the content.
", "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.
", "ListMessageTemplateVersionsRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListMessageTemplatesRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "ListMessagesRequest$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "ListMessagesRequest$sessionId": "The identifier of the Amazon Q in Connect session.
", "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.
", "RenderMessageTemplateRequest$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.
", "SearchMessageTemplatesRequest$knowledgeBaseId": "The identifier of the 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.
", "SendMessageRequest$assistantId": "The identifier of the Amazon Q in Connect assistant.
", "SendMessageRequest$sessionId": "The identifier of the Amazon Q in Connect session.
", "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.
", "UpdateAIGuardrailRequest$assistantId": "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$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
", "UpdateContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain 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.
", "UpdateMessageTemplateMetadataRequest$knowledgeBaseId": "The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "UpdateMessageTemplateRequest$knowledgeBaseId": "The identifier of the 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": { "ActivateMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "CreateAIAgentVersionRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent.
", "CreateAIGuardrailVersionRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "CreateAIPromptVersionRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "CreateMessageTemplateAttachmentRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "CreateMessageTemplateVersionRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "DeactivateMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "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.
", "DeleteAIGuardrailRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "DeleteAIGuardrailVersionRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "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.
", "DeleteMessageTemplateAttachmentRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "DeleteMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN.
", "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.
", "GetAIGuardrailRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "GetAIPromptRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI prompt.
", "GetMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN.
", "ListAIAgentVersionsRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
", "ListAIGuardrailVersionsRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail 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.
", "ListMessageTemplateVersionsRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "RenderMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN.
", "UpdateAIAgentRequest$aiAgentId": "The identifier of the Amazon Q in Connect AI Agent.
", "UpdateAIGuardrailRequest$aiGuardrailId": "The identifier of the Amazon Q in Connect AI Guardrail.
", "UpdateAIPromptRequest$aiPromptId": "The identifier of the Amazon Q in Connect AI Prompt.
", "UpdateMessageTemplateMetadataRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "UpdateMessageTemplateRequest$messageTemplateId": "The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
" } }, "UuidWithQualifier": { "base": null, "refs": { "AIAgentConfigurationData$aiAgentId": "The ID of the AI Agent to be configured.
", "AnswerRecommendationAIAgentConfiguration$intentLabelingGenerationAIPromptId": "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 ANSWER_RECOMMENDATION AI Agent.
The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
", "ManualSearchAIAgentConfiguration$answerGenerationAIGuardrailId": "The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
", "SelfServiceAIAgentConfiguration$selfServicePreProcessingAIPromptId": "The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
", "SelfServiceAIAgentConfiguration$selfServiceAnswerGenerationAIPromptId": "The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
", "SelfServiceAIAgentConfiguration$selfServiceAIGuardrailId": "The AI Guardrail identifier used by the SELF_SERVICE 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.
", "AIGuardrailVersionSummary$versionNumber": "The version number for this AI Guardrail version.
", "AIPromptVersionSummary$versionNumber": "The version number for this AI Prompt version.
", "ActivateMessageTemplateRequest$versionNumber": "The version number of the message template version to activate.
", "ActivateMessageTemplateResponse$versionNumber": "The version number of the message template version that is activated.
", "CreateAIAgentVersionResponse$versionNumber": "The version number of the AI Agent version.
", "CreateAIGuardrailVersionResponse$versionNumber": "The version number of the AI Guardrail version.
", "CreateAIPromptVersionResponse$versionNumber": "The version number of the AI Prompt version.
", "DeactivateMessageTemplateRequest$versionNumber": "The version number of the message template version to deactivate.
", "DeactivateMessageTemplateResponse$versionNumber": "The version number of the message template version that has been deactivated.
", "DeleteAIAgentVersionRequest$versionNumber": "The version number of the AI Agent version.
", "DeleteAIGuardrailVersionRequest$versionNumber": "The version number of the AI Guardrail version to be deleted.
", "DeleteAIPromptVersionRequest$versionNumber": "The version number of the AI Prompt version to be deleted.
", "ExtendedMessageTemplateData$versionNumber": "The version number of the message template version.
", "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 Guardrail version (returned if an AI Guardrail version was specified via use of a qualifier for the aiGuardrailId 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 version number of the message template version.
", "MessageTemplateSummary$activeVersionNumber": "The version number of the message template version that is activated.
", "MessageTemplateVersionSummary$versionNumber": "The version number of the message template version.
" } }, "VisibilityStatus": { "base": null, "refs": { "AIAgentData$visibilityStatus": "The visibility status of the AI Agent.
", "AIAgentSummary$visibilityStatus": "The visibility status of the AI Agent.
", "AIGuardrailData$visibilityStatus": "The visibility status of the AI Guardrail.
", "AIGuardrailSummary$visibilityStatus": "The visibility status of the AI Guardrail.
", "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.
", "CreateAIGuardrailRequest$visibilityStatus": "The visibility status of the AI Guardrail.
", "CreateAIPromptRequest$visibilityStatus": "The visibility status of the AI Prompt.
", "UpdateAIAgentRequest$visibilityStatus": "The visbility status of the Amazon Q in Connect AI Agent.
", "UpdateAIGuardrailRequest$visibilityStatus": "The visibility status of the Amazon Q in Connect AI Guardrail.
", "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
" } } } }