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.
", "idempotent":true }, "CreateAIAgentVersion":{ "name":"CreateAIAgentVersion", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions", "responseCode":200 }, "input":{"shape":"CreateAIAgentVersionRequest"}, "output":{"shape":"CreateAIAgentVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates and Amazon Q in Connect AI Agent version.
", "idempotent":true }, "CreateAIGuardrail":{ "name":"CreateAIGuardrail", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiguardrails", "responseCode":200 }, "input":{"shape":"CreateAIGuardrailRequest"}, "output":{"shape":"CreateAIGuardrailResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an Amazon Q in Connect AI Guardrail.
", "idempotent":true }, "CreateAIGuardrailVersion":{ "name":"CreateAIGuardrailVersion", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}/versions", "responseCode":200 }, "input":{"shape":"CreateAIGuardrailVersionRequest"}, "output":{"shape":"CreateAIGuardrailVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an Amazon Q in Connect AI Guardrail version.
", "idempotent":true }, "CreateAIPrompt":{ "name":"CreateAIPrompt", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiprompts", "responseCode":200 }, "input":{"shape":"CreateAIPromptRequest"}, "output":{"shape":"CreateAIPromptResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an Amazon Q in Connect AI Prompt.
", "idempotent":true }, "CreateAIPromptVersion":{ "name":"CreateAIPromptVersion", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", "responseCode":200 }, "input":{"shape":"CreateAIPromptVersionRequest"}, "output":{"shape":"CreateAIPromptVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Creates an Amazon Q in Connect AI Prompt version.
", "idempotent":true }, "CreateAssistant":{ "name":"CreateAssistant", "http":{ "method":"POST", "requestUri":"/assistants", "responseCode":200 }, "input":{"shape":"CreateAssistantRequest"}, "output":{"shape":"CreateAssistantResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"Creates an Amazon Q in Connect assistant.
", "idempotent":true }, "CreateAssistantAssociation":{ "name":"CreateAssistantAssociation", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/associations", "responseCode":200 }, "input":{"shape":"CreateAssistantAssociationRequest"}, "output":{"shape":"CreateAssistantAssociationResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "CreateContent":{ "name":"CreateContent", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", "responseCode":200 }, "input":{"shape":"CreateContentRequest"}, "output":{"shape":"CreateContentResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
", "idempotent":true }, "CreateContentAssociation":{ "name":"CreateContentAssociation", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", "responseCode":200 }, "input":{"shape":"CreateContentAssociationRequest"}, "output":{"shape":"CreateContentAssociationResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"CreateKnowledgeBase", "http":{ "method":"POST", "requestUri":"/knowledgeBases", "responseCode":200 }, "input":{"shape":"CreateKnowledgeBaseRequest"}, "output":{"shape":"CreateKnowledgeBaseResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"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.
", "idempotent":true }, "CreateSession":{ "name":"CreateSession", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/sessions", "responseCode":200 }, "input":{"shape":"CreateSessionRequest"}, "output":{"shape":"CreateSessionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "DeactivateMessageTemplate":{ "name":"DeactivateMessageTemplate", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/deactivate", "responseCode":200 }, "input":{"shape":"DeactivateMessageTemplateRequest"}, "output":{"shape":"DeactivateMessageTemplateResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
", "idempotent":true }, "DeleteAIAgentVersion":{ "name":"DeleteAIAgentVersion", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions/{versionNumber}", "responseCode":204 }, "input":{"shape":"DeleteAIAgentVersionRequest"}, "output":{"shape":"DeleteAIAgentVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes an Amazon Q in Connect AI Agent Version.
", "idempotent":true }, "DeleteAIGuardrail":{ "name":"DeleteAIGuardrail", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}", "responseCode":202 }, "input":{"shape":"DeleteAIGuardrailRequest"}, "output":{"shape":"DeleteAIGuardrailResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes an Amazon Q in Connect AI Guardrail.
", "idempotent":true }, "DeleteAIGuardrailVersion":{ "name":"DeleteAIGuardrailVersion", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}/versions/{versionNumber}", "responseCode":202 }, "input":{"shape":"DeleteAIGuardrailVersionRequest"}, "output":{"shape":"DeleteAIGuardrailVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Delete and Amazon Q in Connect AI Guardrail version.
", "idempotent":true }, "DeleteAIPrompt":{ "name":"DeleteAIPrompt", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", "responseCode":204 }, "input":{"shape":"DeleteAIPromptRequest"}, "output":{"shape":"DeleteAIPromptResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Deletes an Amazon Q in Connect AI Prompt.
", "idempotent":true }, "DeleteAIPromptVersion":{ "name":"DeleteAIPromptVersion", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions/{versionNumber}", "responseCode":204 }, "input":{"shape":"DeleteAIPromptVersionRequest"}, "output":{"shape":"DeleteAIPromptVersionResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Delete and Amazon Q in Connect AI Prompt version.
", "idempotent":true }, "DeleteAssistant":{ "name":"DeleteAssistant", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}", "responseCode":204 }, "input":{"shape":"DeleteAssistantRequest"}, "output":{"shape":"DeleteAssistantResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes an assistant.
", "idempotent":true }, "DeleteAssistantAssociation":{ "name":"DeleteAssistantAssociation", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", "responseCode":204 }, "input":{"shape":"DeleteAssistantAssociationRequest"}, "output":{"shape":"DeleteAssistantAssociationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes an assistant association.
", "idempotent":true }, "DeleteContent":{ "name":"DeleteContent", "http":{ "method":"DELETE", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "responseCode":204 }, "input":{"shape":"DeleteContentRequest"}, "output":{"shape":"DeleteContentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes the content.
", "idempotent":true }, "DeleteContentAssociation":{ "name":"DeleteContentAssociation", "http":{ "method":"DELETE", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId}", "responseCode":204 }, "input":{"shape":"DeleteContentAssociationRequest"}, "output":{"shape":"DeleteContentAssociationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "DeleteImportJob":{ "name":"DeleteImportJob", "http":{ "method":"DELETE", "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", "responseCode":204 }, "input":{"shape":"DeleteImportJobRequest"}, "output":{"shape":"DeleteImportJobResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes the quick response import job.
", "idempotent":true }, "DeleteKnowledgeBase":{ "name":"DeleteKnowledgeBase", "http":{ "method":"DELETE", "requestUri":"/knowledgeBases/{knowledgeBaseId}", "responseCode":204 }, "input":{"shape":"DeleteKnowledgeBaseRequest"}, "output":{"shape":"DeleteKnowledgeBaseResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "GetAIAgent":{ "name":"GetAIAgent", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}", "responseCode":200 }, "input":{"shape":"GetAIAgentRequest"}, "output":{"shape":"GetAIAgentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Gets an Amazon Q in Connect AI Agent.
" }, "GetAIGuardrail":{ "name":"GetAIGuardrail", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}", "responseCode":200 }, "input":{"shape":"GetAIGuardrailRequest"}, "output":{"shape":"GetAIGuardrailResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Gets the Amazon Q in Connect AI Guardrail.
" }, "GetAIPrompt":{ "name":"GetAIPrompt", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", "responseCode":200 }, "input":{"shape":"GetAIPromptRequest"}, "output":{"shape":"GetAIPromptResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Gets and Amazon Q in Connect AI Prompt.
" }, "GetAssistant":{ "name":"GetAssistant", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}", "responseCode":200 }, "input":{"shape":"GetAssistantRequest"}, "output":{"shape":"GetAssistantResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves information about an assistant.
" }, "GetAssistantAssociation":{ "name":"GetAssistantAssociation", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", "responseCode":200 }, "input":{"shape":"GetAssistantAssociationRequest"}, "output":{"shape":"GetAssistantAssociationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves information about an assistant association.
" }, "GetContent":{ "name":"GetContent", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "responseCode":200 }, "input":{"shape":"GetContentRequest"}, "output":{"shape":"GetContentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves content, including a pre-signed URL to download the content.
" }, "GetContentAssociation":{ "name":"GetContentAssociation", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId}", "responseCode":200 }, "input":{"shape":"GetContentAssociationRequest"}, "output":{"shape":"GetContentAssociationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"GetContentSummary", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", "responseCode":200 }, "input":{"shape":"GetContentSummaryRequest"}, "output":{"shape":"GetContentSummaryResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves summary information about the content.
" }, "GetImportJob":{ "name":"GetImportJob", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", "responseCode":200 }, "input":{"shape":"GetImportJobRequest"}, "output":{"shape":"GetImportJobResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves the started import job.
" }, "GetKnowledgeBase":{ "name":"GetKnowledgeBase", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}", "responseCode":200 }, "input":{"shape":"GetKnowledgeBaseRequest"}, "output":{"shape":"GetKnowledgeBaseResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves information about the knowledge base.
" }, "GetMessageTemplate":{ "name":"GetMessageTemplate", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}", "responseCode":200 }, "input":{"shape":"GetMessageTemplateRequest"}, "output":{"shape":"GetMessageTemplateResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"GetQuickResponse", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "responseCode":200 }, "input":{"shape":"GetQuickResponseRequest"}, "output":{"shape":"GetQuickResponseResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves the quick response.
" }, "GetRecommendations":{ "name":"GetRecommendations", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations", "responseCode":200 }, "input":{"shape":"GetRecommendationsRequest"}, "output":{"shape":"GetRecommendationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"ListAIAgentVersions", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions", "responseCode":200 }, "input":{"shape":"ListAIAgentVersionsRequest"}, "output":{"shape":"ListAIAgentVersionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"List AI Agent versions.
" }, "ListAIAgents":{ "name":"ListAIAgents", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiagents", "responseCode":200 }, "input":{"shape":"ListAIAgentsRequest"}, "output":{"shape":"ListAIAgentsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists AI Agents.
" }, "ListAIGuardrailVersions":{ "name":"ListAIGuardrailVersions", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}/versions", "responseCode":200 }, "input":{"shape":"ListAIGuardrailVersionsRequest"}, "output":{"shape":"ListAIGuardrailVersionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists AI Guardrail versions.
" }, "ListAIGuardrails":{ "name":"ListAIGuardrails", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiguardrails", "responseCode":200 }, "input":{"shape":"ListAIGuardrailsRequest"}, "output":{"shape":"ListAIGuardrailsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists the AI Guardrails available on the Amazon Q in Connect assistant.
" }, "ListAIPromptVersions":{ "name":"ListAIPromptVersions", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", "responseCode":200 }, "input":{"shape":"ListAIPromptVersionsRequest"}, "output":{"shape":"ListAIPromptVersionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists AI Prompt versions.
" }, "ListAIPrompts":{ "name":"ListAIPrompts", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/aiprompts", "responseCode":200 }, "input":{"shape":"ListAIPromptsRequest"}, "output":{"shape":"ListAIPromptsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists the AI Prompts available on the Amazon Q in Connect assistant.
" }, "ListAssistantAssociations":{ "name":"ListAssistantAssociations", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/associations", "responseCode":200 }, "input":{"shape":"ListAssistantAssociationsRequest"}, "output":{"shape":"ListAssistantAssociationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists information about assistant associations.
" }, "ListAssistants":{ "name":"ListAssistants", "http":{ "method":"GET", "requestUri":"/assistants", "responseCode":200 }, "input":{"shape":"ListAssistantsRequest"}, "output":{"shape":"ListAssistantsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists information about assistants.
" }, "ListContentAssociations":{ "name":"ListContentAssociations", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", "responseCode":200 }, "input":{"shape":"ListContentAssociationsRequest"}, "output":{"shape":"ListContentAssociationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"ListContents", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", "responseCode":200 }, "input":{"shape":"ListContentsRequest"}, "output":{"shape":"ListContentsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists the content.
" }, "ListImportJobs":{ "name":"ListImportJobs", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", "responseCode":200 }, "input":{"shape":"ListImportJobsRequest"}, "output":{"shape":"ListImportJobsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists information about import jobs.
" }, "ListKnowledgeBases":{ "name":"ListKnowledgeBases", "http":{ "method":"GET", "requestUri":"/knowledgeBases", "responseCode":200 }, "input":{"shape":"ListKnowledgeBasesRequest"}, "output":{"shape":"ListKnowledgeBasesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Lists the knowledge bases.
" }, "ListMessageTemplateVersions":{ "name":"ListMessageTemplateVersions", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/versions", "responseCode":200 }, "input":{"shape":"ListMessageTemplateVersionsRequest"}, "output":{"shape":"ListMessageTemplateVersionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists all the available versions for the specified Amazon Q in Connect message template.
" }, "ListMessageTemplates":{ "name":"ListMessageTemplates", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates", "responseCode":200 }, "input":{"shape":"ListMessageTemplatesRequest"}, "output":{"shape":"ListMessageTemplatesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
" }, "ListMessages":{ "name":"ListMessages", "http":{ "method":"GET", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/messages", "responseCode":200 }, "input":{"shape":"ListMessagesRequest"}, "output":{"shape":"ListMessagesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists messages on an Amazon Q in Connect session.
" }, "ListQuickResponses":{ "name":"ListQuickResponses", "http":{ "method":"GET", "requestUri":"/knowledgeBases/{knowledgeBaseId}/quickResponses", "responseCode":200 }, "input":{"shape":"ListQuickResponsesRequest"}, "output":{"shape":"ListQuickResponsesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists information about quick response.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Lists the tags for the specified resource.
" }, "NotifyRecommendationsReceived":{ "name":"NotifyRecommendationsReceived", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", "responseCode":200 }, "input":{"shape":"NotifyRecommendationsReceivedRequest"}, "output":{"shape":"NotifyRecommendationsReceivedResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "QueryAssistant":{ "name":"QueryAssistant", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/query", "responseCode":200 }, "input":{"shape":"QueryAssistantRequest"}, "output":{"shape":"QueryAssistantResponse"}, "errors":[ {"shape":"RequestTimeoutException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "deprecated":true, "deprecatedMessage":"QueryAssistant 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, "RemoveAssistantAIAgent":{ "name":"RemoveAssistantAIAgent", "http":{ "method":"DELETE", "requestUri":"/assistants/{assistantId}/aiagentConfiguration", "responseCode":204 }, "input":{"shape":"RemoveAssistantAIAgentRequest"}, "output":{"shape":"RemoveAssistantAIAgentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
", "idempotent":true }, "RemoveKnowledgeBaseTemplateUri":{ "name":"RemoveKnowledgeBaseTemplateUri", "http":{ "method":"DELETE", "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", "responseCode":204 }, "input":{"shape":"RemoveKnowledgeBaseTemplateUriRequest"}, "output":{"shape":"RemoveKnowledgeBaseTemplateUriResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes a URI template from a knowledge base.
" }, "RenderMessageTemplate":{ "name":"RenderMessageTemplate", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/render", "responseCode":200 }, "input":{"shape":"RenderMessageTemplateRequest"}, "output":{"shape":"RenderMessageTemplateResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"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":{ "name":"SearchContent", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/search", "responseCode":200 }, "input":{"shape":"SearchContentRequest"}, "output":{"shape":"SearchContentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
" }, "SearchMessageTemplates":{ "name":"SearchMessageTemplates", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/search/messageTemplates", "responseCode":200 }, "input":{"shape":"SearchMessageTemplatesRequest"}, "output":{"shape":"SearchMessageTemplatesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Searches for Amazon Q in Connect message templates in the specified knowledge base.
" }, "SearchQuickResponses":{ "name":"SearchQuickResponses", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/search/quickResponses", "responseCode":200 }, "input":{"shape":"SearchQuickResponsesRequest"}, "output":{"shape":"SearchQuickResponsesResponse"}, "errors":[ {"shape":"RequestTimeoutException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
" }, "SearchSessions":{ "name":"SearchSessions", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/searchSessions", "responseCode":200 }, "input":{"shape":"SearchSessionsRequest"}, "output":{"shape":"SearchSessionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Searches for sessions.
" }, "SendMessage":{ "name":"SendMessage", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/message", "responseCode":200 }, "input":{"shape":"SendMessageRequest"}, "output":{"shape":"SendMessageResponse"}, "errors":[ {"shape":"RequestTimeoutException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Submits a message to the Amazon Q in Connect session.
", "idempotent":true }, "StartContentUpload":{ "name":"StartContentUpload", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/upload", "responseCode":200 }, "input":{"shape":"StartContentUploadRequest"}, "output":{"shape":"StartContentUploadResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"StartImportJob", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/importJobs", "responseCode":200 }, "input":{"shape":"StartImportJobRequest"}, "output":{"shape":"StartImportJobResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Removes the specified tags from the specified resource.
", "idempotent":true }, "UpdateAIAgent":{ "name":"UpdateAIAgent", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}", "responseCode":200 }, "input":{"shape":"UpdateAIAgentRequest"}, "output":{"shape":"UpdateAIAgentResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates an AI Agent.
", "idempotent":true }, "UpdateAIGuardrail":{ "name":"UpdateAIGuardrail", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiguardrails/{aiGuardrailId}", "responseCode":200 }, "input":{"shape":"UpdateAIGuardrailRequest"}, "output":{"shape":"UpdateAIGuardrailResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates an AI Guardrail.
", "idempotent":true }, "UpdateAIPrompt":{ "name":"UpdateAIPrompt", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", "responseCode":200 }, "input":{"shape":"UpdateAIPromptRequest"}, "output":{"shape":"UpdateAIPromptResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates an AI Prompt.
", "idempotent":true }, "UpdateAssistantAIAgent":{ "name":"UpdateAssistantAIAgent", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/aiagentConfiguration", "responseCode":200 }, "input":{"shape":"UpdateAssistantAIAgentRequest"}, "output":{"shape":"UpdateAssistantAIAgentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
" }, "UpdateContent":{ "name":"UpdateContent", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "responseCode":200 }, "input":{"shape":"UpdateContentRequest"}, "output":{"shape":"UpdateContentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"PreconditionFailedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates information about the content.
" }, "UpdateKnowledgeBaseTemplateUri":{ "name":"UpdateKnowledgeBaseTemplateUri", "http":{ "method":"POST", "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", "responseCode":200 }, "input":{"shape":"UpdateKnowledgeBaseTemplateUriRequest"}, "output":{"shape":"UpdateKnowledgeBaseTemplateUriResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"UpdateSession", "http":{ "method":"POST", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}", "responseCode":200 }, "input":{"shape":"UpdateSessionRequest"}, "output":{"shape":"UpdateSessionResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"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":{ "name":"UpdateSessionData", "http":{ "method":"PATCH", "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/data", "responseCode":200 }, "input":{"shape":"UpdateSessionDataRequest"}, "output":{"shape":"UpdateSessionDataResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Updates the data stored on an Amazon Q in Connect Session.
" } }, "shapes":{ "AIAgentAssociationConfigurationType":{ "type":"string", "enum":["KNOWLEDGE_BASE"] }, "AIAgentConfiguration":{ "type":"structure", "members":{ "answerRecommendationAIAgentConfiguration":{ "shape":"AnswerRecommendationAIAgentConfiguration", "documentation":"The configuration for AI Agents of type ANSWER_RECOMMENDATION.
The configuration for AI Agents of type MANUAL_SEARCH.
The configuration for AI Agents of type SELF_SERVICE.
" } }, "documentation":"A typed union that specifies the configuration based on the type of AI Agent.
", "union":true }, "AIAgentConfigurationData":{ "type":"structure", "required":["aiAgentId"], "members":{ "aiAgentId":{ "shape":"UuidWithQualifier", "documentation":"The ID of the AI Agent to be configured.
" } }, "documentation":"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.
" }, "AIAgentConfigurationMap":{ "type":"map", "key":{"shape":"AIAgentType"}, "value":{"shape":"AIAgentConfigurationData"} }, "AIAgentData":{ "type":"structure", "required":[ "aiAgentArn", "aiAgentId", "assistantArn", "assistantId", "configuration", "name", "type", "visibilityStatus" ], "members":{ "aiAgentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI agent.
" }, "aiAgentId":{ "shape":"Uuid", "documentation":"The identifier of the AI Agent.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "configuration":{ "shape":"AIAgentConfiguration", "documentation":"Configuration for the AI Agent.
" }, "description":{ "shape":"Description", "documentation":"The description of the AI Agent.
" }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Agent was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Agent.
" }, "origin":{ "shape":"Origin", "documentation":"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 status of the AI Agent.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AIAgentType", "documentation":"The type of the AI Agent.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Agent.
" } }, "documentation":"The data for the AI Agent.
" }, "AIAgentSummary":{ "type":"structure", "required":[ "aiAgentArn", "aiAgentId", "assistantArn", "assistantId", "name", "type", "visibilityStatus" ], "members":{ "aiAgentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI agent.
" }, "aiAgentId":{ "shape":"Uuid", "documentation":"The identifier of the AI Agent.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "configuration":{ "shape":"AIAgentConfiguration", "documentation":"The configuration for the AI Agent.
" }, "description":{ "shape":"Description", "documentation":"The description of the AI Agent.
" }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Agent was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Agent.
" }, "origin":{ "shape":"Origin", "documentation":"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 status of the AI Agent.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AIAgentType", "documentation":"The type of the AI Agent.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Agent.
" } }, "documentation":"The summary of the AI Agent.
" }, "AIAgentSummaryList":{ "type":"list", "member":{"shape":"AIAgentSummary"} }, "AIAgentType":{ "type":"string", "enum":[ "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE" ] }, "AIAgentVersionSummariesList":{ "type":"list", "member":{"shape":"AIAgentVersionSummary"} }, "AIAgentVersionSummary":{ "type":"structure", "members":{ "aiAgentSummary":{ "shape":"AIAgentSummary", "documentation":"The data for the summary of the AI Agent version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number for this AI Agent version.
" } }, "documentation":"The summary of the AI Agent version.
" }, "AIGuardrailBlockedMessaging":{ "type":"string", "documentation":"Messaging for when violations are detected in text
", "max":500, "min":1, "sensitive":true }, "AIGuardrailContentPolicyConfig":{ "type":"structure", "required":["filtersConfig"], "members":{ "filtersConfig":{ "shape":"GuardrailContentFiltersConfig", "documentation":"Contains the type of the content filter and how strongly it should apply to prompts and model responses.
" } }, "documentation":"Contains details about how to handle harmful content.
" }, "AIGuardrailContextualGroundingPolicyConfig":{ "type":"structure", "required":["filtersConfig"], "members":{ "filtersConfig":{ "shape":"GuardrailContextualGroundingFiltersConfig", "documentation":"The filter configuration details for the AI Guardrails contextual grounding policy.
" } }, "documentation":"The policy configuration details for the AI Guardrail's contextual grounding policy.
" }, "AIGuardrailData":{ "type":"structure", "required":[ "aiGuardrailArn", "aiGuardrailId", "assistantArn", "assistantId", "blockedInputMessaging", "blockedOutputsMessaging", "name", "visibilityStatus" ], "members":{ "aiGuardrailArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI Guardrail.
" }, "aiGuardrailId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "blockedInputMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a prompt.
" }, "blockedOutputsMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a model response.
" }, "contentPolicyConfig":{ "shape":"AIGuardrailContentPolicyConfig", "documentation":"Contains details about how to handle harmful content.
" }, "contextualGroundingPolicyConfig":{ "shape":"AIGuardrailContextualGroundingPolicyConfig", "documentation":"The policy configuration details for the AI Guardrail's contextual grounding policy.
" }, "description":{ "shape":"AIGuardrailDescription", "documentation":"A description of the AI Guardrail.
" }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Guardrail was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Guardrail.
" }, "sensitiveInformationPolicyConfig":{ "shape":"AIGuardrailSensitiveInformationPolicyConfig", "documentation":"Contains details about PII entities and regular expressions to configure for the AI Guardrail.
" }, "status":{ "shape":"Status", "documentation":"The status of the AI Guardrail.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "topicPolicyConfig":{ "shape":"AIGuardrailTopicPolicyConfig", "documentation":"Contains details about topics that the AI Guardrail should identify and deny.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Guardrail.
" }, "wordPolicyConfig":{ "shape":"AIGuardrailWordPolicyConfig", "documentation":"Contains details about the word policy to configured for the AI Guardrail.
" } }, "documentation":"The data for the AI Guardrail
" }, "AIGuardrailDescription":{ "type":"string", "documentation":"Description of the guardrail or its version
", "max":200, "min":1, "sensitive":true }, "AIGuardrailSensitiveInformationPolicyConfig":{ "type":"structure", "members":{ "piiEntitiesConfig":{ "shape":"GuardrailPiiEntitiesConfig", "documentation":"A list of PII entities to configure to the AI Guardrail.
" }, "regexesConfig":{ "shape":"GuardrailRegexesConfig", "documentation":"A list of regular expressions to configure to the AI Guardrail.
" } }, "documentation":"Contains details about PII entities and regular expressions to configure for the AI Guardrail.
" }, "AIGuardrailSummariesList":{ "type":"list", "member":{"shape":"AIGuardrailSummary"} }, "AIGuardrailSummary":{ "type":"structure", "required":[ "aiGuardrailArn", "aiGuardrailId", "assistantArn", "assistantId", "name", "visibilityStatus" ], "members":{ "aiGuardrailArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI Guardrail.
" }, "aiGuardrailId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "description":{ "shape":"AIGuardrailDescription", "documentation":"A description of the AI Guardrail.
" }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Guardrail was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Guardrail.
" }, "status":{ "shape":"Status", "documentation":"The status of the AI Guardrail.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Guardrail.
" } }, "documentation":"The summary of the AI Guardrail.
" }, "AIGuardrailTopicPolicyConfig":{ "type":"structure", "required":["topicsConfig"], "members":{ "topicsConfig":{ "shape":"GuardrailTopicsConfig", "documentation":"A list of policies related to topics that the AI Guardrail should deny.
" } }, "documentation":"Contains details about topics that the AI Guardrail should identify and deny.
" }, "AIGuardrailVersionSummariesList":{ "type":"list", "member":{"shape":"AIGuardrailVersionSummary"} }, "AIGuardrailVersionSummary":{ "type":"structure", "members":{ "aiGuardrailSummary":{ "shape":"AIGuardrailSummary", "documentation":"The data for the summary of the AI Guardrail version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number for this AI Guardrail version.
" } }, "documentation":"The summary of the AI Guardrail version.
" }, "AIGuardrailWordPolicyConfig":{ "type":"structure", "members":{ "managedWordListsConfig":{ "shape":"GuardrailManagedWordListsConfig", "documentation":"A list of managed words to configure for the AI Guardrail.
" }, "wordsConfig":{ "shape":"GuardrailWordsConfig", "documentation":"A list of words to configure for the AI Guardrail.
" } }, "documentation":"Contains details about the word policy to configured for the AI Guardrail.
" }, "AIPromptAPIFormat":{ "type":"string", "enum":[ "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" ] }, "AIPromptData":{ "type":"structure", "required":[ "aiPromptArn", "aiPromptId", "apiFormat", "assistantArn", "assistantId", "modelId", "name", "templateConfiguration", "templateType", "type", "visibilityStatus" ], "members":{ "aiPromptArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI Prompt.
" }, "aiPromptId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect AI prompt.
" }, "apiFormat":{ "shape":"AIPromptAPIFormat", "documentation":"The API format used for this AI Prompt.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "description":{ "shape":"Description", "documentation":"The description of the AI Prompt.
" }, "modelId":{ "shape":"AIPromptModelIdentifier", "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The time the AI Prompt was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Prompt
" }, "origin":{ "shape":"Origin", "documentation":"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 status of the AI Prompt.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "templateConfiguration":{ "shape":"AIPromptTemplateConfiguration", "documentation":"The configuration of the prompt template for this AI Prompt.
" }, "templateType":{ "shape":"AIPromptTemplateType", "documentation":"The type of the prompt template for this AI Prompt.
" }, "type":{ "shape":"AIPromptType", "documentation":"The type of this AI Prompt.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Prompt.
" } }, "documentation":"The data for the AI Prompt
" }, "AIPromptModelIdentifier":{ "type":"string", "max":2048, "min":1 }, "AIPromptSummary":{ "type":"structure", "required":[ "aiPromptArn", "aiPromptId", "apiFormat", "assistantArn", "assistantId", "modelId", "name", "templateType", "type", "visibilityStatus" ], "members":{ "aiPromptArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the AI Prompt.
" }, "aiPromptId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect AI prompt.
" }, "apiFormat":{ "shape":"AIPromptAPIFormat", "documentation":"The API format used for this AI Prompt.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "description":{ "shape":"Description", "documentation":"The description of the AI Prompt.
" }, "modelId":{ "shape":"AIPromptModelIdentifier", "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The time the AI Prompt was last modified.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Prompt.
" }, "origin":{ "shape":"Origin", "documentation":"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 status of the AI Prompt.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "templateType":{ "shape":"AIPromptTemplateType", "documentation":"The type of the prompt template for this AI Prompt.
" }, "type":{ "shape":"AIPromptType", "documentation":"The type of this AI Prompt.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Prompt.
" } }, "documentation":"The summary of the AI Prompt.
" }, "AIPromptSummaryList":{ "type":"list", "member":{"shape":"AIPromptSummary"} }, "AIPromptTemplateConfiguration":{ "type":"structure", "members":{ "textFullAIPromptEditTemplateConfiguration":{ "shape":"TextFullAIPromptEditTemplateConfiguration", "documentation":"The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
" } }, "documentation":"A typed union that specifies the configuration for a prompt template based on its type.
", "union":true }, "AIPromptTemplateType":{ "type":"string", "enum":["TEXT"] }, "AIPromptType":{ "type":"string", "enum":[ "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION" ] }, "AIPromptVersionSummariesList":{ "type":"list", "member":{"shape":"AIPromptVersionSummary"} }, "AIPromptVersionSummary":{ "type":"structure", "members":{ "aiPromptSummary":{ "shape":"AIPromptSummary", "documentation":"The date for the summary of the AI Prompt version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number for this AI Prompt version.
" } }, "documentation":"The summary of the AI Prompt version.
" }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ActivateMessageTemplateRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId", "versionNumber" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version to activate.
" } } }, "ActivateMessageTemplateResponse":{ "type":"structure", "required":[ "messageTemplateArn", "messageTemplateId", "versionNumber" ], "members":{ "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateId":{ "shape":"Uuid", "documentation":"The identifier of the message template.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version that is activated.
" } } }, "AgentAttributes":{ "type":"structure", "members":{ "firstName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The agent’s first name as entered in their Amazon Connect user account.
" }, "lastName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The agent’s last name as entered in their Amazon Connect user account.
" } }, "documentation":"Information about an agent.
" }, "AmazonConnectGuideAssociationData":{ "type":"structure", "members":{ "flowId":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" } }, "documentation":"Content association data for a step-by-step guide.
" }, "AndConditions":{ "type":"list", "member":{"shape":"TagCondition"} }, "AnswerRecommendationAIAgentConfiguration":{ "type":"structure", "members":{ "answerGenerationAIGuardrailId":{ "shape":"UuidWithQualifier", "documentation":"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 ANSWER_RECOMMENDATION AI Agent.
The association configurations for overriding behavior on this AI Agent.
" }, "intentLabelingGenerationAIPromptId":{ "shape":"UuidWithQualifier", "documentation":"The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
Changing this locale to anything other than en_US will turn off recommendations triggered by contact transcripts for agent assistance, as this feature is not supported in multiple languages.
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
The configuration for the ANSWER_RECOMMENDATION AI Agent type.
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 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.
" } }, "documentation":"Configuration information for Amazon AppIntegrations to automatically ingest content.
" }, "Arn":{ "type":"string", "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" }, "ArnWithQualifier":{ "type":"string", "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$" }, "AssistantAssociationData":{ "type":"structure", "required":[ "assistantArn", "assistantAssociationArn", "assistantAssociationId", "assistantId", "associationData", "associationType" ], "members":{ "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantAssociationArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the assistant association.
" }, "assistantAssociationId":{ "shape":"Uuid", "documentation":"The identifier of the assistant association.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "associationData":{ "shape":"AssistantAssociationOutputData", "documentation":"A union type that currently has a single argument, the knowledge base ID.
" }, "associationType":{ "shape":"AssociationType", "documentation":"The type of association.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Information about the assistant association.
" }, "AssistantAssociationInputData":{ "type":"structure", "members":{ "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" } }, "documentation":"The data that is input into Amazon Q in Connect as a result of the assistant association.
", "union":true }, "AssistantAssociationOutputData":{ "type":"structure", "members":{ "knowledgeBaseAssociation":{ "shape":"KnowledgeBaseAssociationData", "documentation":"The knowledge base where output data is sent.
" } }, "documentation":"The data that is output as a result of the assistant association.
", "union":true }, "AssistantAssociationSummary":{ "type":"structure", "required":[ "assistantArn", "assistantAssociationArn", "assistantAssociationId", "assistantId", "associationData", "associationType" ], "members":{ "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantAssociationArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the assistant association.
" }, "assistantAssociationId":{ "shape":"Uuid", "documentation":"The identifier of the assistant association.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "associationData":{ "shape":"AssistantAssociationOutputData", "documentation":"The association data.
" }, "associationType":{ "shape":"AssociationType", "documentation":"The type of association.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Summary information about the assistant association.
" }, "AssistantAssociationSummaryList":{ "type":"list", "member":{"shape":"AssistantAssociationSummary"} }, "AssistantCapabilityConfiguration":{ "type":"structure", "members":{ "type":{ "shape":"AssistantCapabilityType", "documentation":"The type of Amazon Q in Connect assistant capability.
" } }, "documentation":"The capability configuration for an Amazon Q in Connect assistant.
" }, "AssistantCapabilityType":{ "type":"string", "enum":[ "V1", "V2" ] }, "AssistantData":{ "type":"structure", "required":[ "assistantArn", "assistantId", "name", "status", "type" ], "members":{ "aiAgentConfiguration":{ "shape":"AIAgentConfigurationMap", "documentation":"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.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "capabilityConfiguration":{ "shape":"AssistantCapabilityConfiguration", "documentation":"The configuration information for the Amazon Q in Connect assistant capability.
" }, "description":{ "shape":"Description", "documentation":"The description.
" }, "integrationConfiguration":{ "shape":"AssistantIntegrationConfiguration", "documentation":"The configuration information for the Amazon Q in Connect assistant integration.
" }, "name":{ "shape":"Name", "documentation":"The name.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "status":{ "shape":"AssistantStatus", "documentation":"The status of the assistant.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AssistantType", "documentation":"The type of assistant.
" } }, "documentation":"The assistant data.
" }, "AssistantIntegrationConfiguration":{ "type":"structure", "members":{ "topicIntegrationArn":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } }, "documentation":"The configuration information for the Amazon Q in Connect assistant integration.
" }, "AssistantList":{ "type":"list", "member":{"shape":"AssistantSummary"} }, "AssistantStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED" ] }, "AssistantSummary":{ "type":"structure", "required":[ "assistantArn", "assistantId", "name", "status", "type" ], "members":{ "aiAgentConfiguration":{ "shape":"AIAgentConfigurationMap", "documentation":"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.
" }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "capabilityConfiguration":{ "shape":"AssistantCapabilityConfiguration", "documentation":"The configuration information for the Amazon Q in Connect assistant capability.
" }, "description":{ "shape":"Description", "documentation":"The description of the assistant.
" }, "integrationConfiguration":{ "shape":"AssistantIntegrationConfiguration", "documentation":"The configuration information for the Amazon Q in Connect assistant integration.
" }, "name":{ "shape":"Name", "documentation":"The name of the assistant.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "status":{ "shape":"AssistantStatus", "documentation":"The status of the assistant.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AssistantType", "documentation":"The type of the assistant.
" } }, "documentation":"Summary information about the assistant.
" }, "AssistantType":{ "type":"string", "enum":["AGENT"] }, "AssociationConfiguration":{ "type":"structure", "members":{ "associationConfigurationData":{ "shape":"AssociationConfigurationData", "documentation":"The data of the configuration for an Amazon Q in Connect Assistant Association.
" }, "associationId":{ "shape":"Uuid", "documentation":"The identifier of the association for this Association Configuration.
" }, "associationType":{ "shape":"AIAgentAssociationConfigurationType", "documentation":"The type of the association for this Association Configuration.
" } }, "documentation":"The configuration for an Amazon Q in Connect Assistant Association.
" }, "AssociationConfigurationData":{ "type":"structure", "members":{ "knowledgeBaseAssociationConfigurationData":{ "shape":"KnowledgeBaseAssociationConfigurationData", "documentation":"The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
", "union":true }, "AssociationConfigurationList":{ "type":"list", "member":{"shape":"AssociationConfiguration"} }, "AssociationType":{ "type":"string", "enum":["KNOWLEDGE_BASE"] }, "AttachmentFileName":{ "type":"string", "max":256, "min":1, "pattern":"^[\\p{L}\\p{M}\\p{N}_\\s&@()+,;=\\-]+\\.[A-Za-z0-9]+$", "sensitive":true }, "BedrockFoundationModelConfigurationForParsing":{ "type":"structure", "required":["modelArn"], "members":{ "modelArn":{ "shape":"BedrockModelArnForParsing", "documentation":"The ARN of the foundation model.
" }, "parsingPrompt":{ "shape":"ParsingPrompt", "documentation":"Instructions for interpreting the contents of a document.
" } }, "documentation":"Settings for a foundation model used to parse documents for a data source.
" }, "BedrockModelArnForParsing":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/anthropic.claude-3-haiku-20240307-v1:0$" }, "Boolean":{ "type":"boolean", "box":true }, "Channel":{ "type":"string", "max":10, "min":1, "sensitive":true }, "ChannelSubtype":{ "type":"string", "enum":[ "EMAIL", "SMS" ] }, "Channels":{ "type":"list", "member":{"shape":"Channel"} }, "ChunkingConfiguration":{ "type":"structure", "required":["chunkingStrategy"], "members":{ "chunkingStrategy":{ "shape":"ChunkingStrategy", "documentation":"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.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
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.
" }, "semanticChunkingConfiguration":{ "shape":"SemanticChunkingConfiguration", "documentation":"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.
" } }, "documentation":"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":{ "type":"string", "enum":[ "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC" ] }, "CitationSpan":{ "type":"structure", "members":{ "beginOffsetInclusive":{ "shape":"CitationSpanOffset", "documentation":"Where the text with a citation starts in the generated output.
" }, "endOffsetExclusive":{ "shape":"CitationSpanOffset", "documentation":"Where the text with a citation ends in the generated output.
" } }, "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" }, "CitationSpanOffset":{"type":"integer"}, "ClientToken":{ "type":"string", "max":4096, "min":1 }, "Configuration":{ "type":"structure", "members":{ "connectConfiguration":{ "shape":"ConnectConfiguration", "documentation":"The configuration information of the Amazon Connect data source.
" } }, "documentation":"The configuration information of the external data source.
", "union":true }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"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 identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
" } }, "documentation":"The configuration information of the Amazon Connect data source.
" }, "ContactAttributeKey":{"type":"string"}, "ContactAttributeKeys":{ "type":"list", "member":{"shape":"ContactAttributeKey"}, "sensitive":true }, "ContactAttributeValue":{"type":"string"}, "ContactAttributes":{ "type":"map", "key":{"shape":"ContactAttributeKey"}, "value":{"shape":"ContactAttributeValue"}, "sensitive":true }, "ContentAssociationContents":{ "type":"structure", "members":{ "amazonConnectGuideAssociation":{ "shape":"AmazonConnectGuideAssociationData", "documentation":"The data of the step-by-step guide association.
" } }, "documentation":"The contents of a content association.
", "union":true }, "ContentAssociationData":{ "type":"structure", "required":[ "associationData", "associationType", "contentArn", "contentAssociationArn", "contentAssociationId", "contentId", "knowledgeBaseArn", "knowledgeBaseId" ], "members":{ "associationData":{ "shape":"ContentAssociationContents", "documentation":"The content association.
" }, "associationType":{ "shape":"ContentAssociationType", "documentation":"The type of association.
" }, "contentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content.
" }, "contentAssociationArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content association.
" }, "contentAssociationId":{ "shape":"Uuid", "documentation":"The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "contentId":{ "shape":"Uuid", "documentation":"The identifier of the content.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Information about the content association.
" }, "ContentAssociationSummary":{ "type":"structure", "required":[ "associationData", "associationType", "contentArn", "contentAssociationArn", "contentAssociationId", "contentId", "knowledgeBaseArn", "knowledgeBaseId" ], "members":{ "associationData":{ "shape":"ContentAssociationContents", "documentation":"The content association.
" }, "associationType":{ "shape":"ContentAssociationType", "documentation":"The type of association.
" }, "contentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content.
" }, "contentAssociationArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content association.
" }, "contentAssociationId":{ "shape":"Uuid", "documentation":"The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "contentId":{ "shape":"Uuid", "documentation":"The identifier of the content.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Summary information about a content association.
" }, "ContentAssociationSummaryList":{ "type":"list", "member":{"shape":"ContentAssociationSummary"} }, "ContentAssociationType":{ "type":"string", "enum":["AMAZON_CONNECT_GUIDE"] }, "ContentData":{ "type":"structure", "required":[ "contentArn", "contentId", "contentType", "knowledgeBaseArn", "knowledgeBaseId", "metadata", "name", "revisionId", "status", "title", "url", "urlExpiry" ], "members":{ "contentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content.
" }, "contentId":{ "shape":"Uuid", "documentation":"The identifier of the content.
" }, "contentType":{ "shape":"ContentType", "documentation":"The media type of the content.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "linkOutUri":{ "shape":"Uri", "documentation":"The URI of the content.
" }, "metadata":{ "shape":"ContentMetadata", "documentation":"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.
" }, "name":{ "shape":"Name", "documentation":"The name of the content.
" }, "revisionId":{ "shape":"NonEmptyString", "documentation":"The identifier of the content revision.
" }, "status":{ "shape":"ContentStatus", "documentation":"The status of the content.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "title":{ "shape":"ContentTitle", "documentation":"The title of the content.
" }, "url":{ "shape":"Url", "documentation":"The URL of the content.
" }, "urlExpiry":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The expiration time of the URL as an epoch timestamp.
" } }, "documentation":"Information about the content.
" }, "ContentDataDetails":{ "type":"structure", "required":[ "rankingData", "textData" ], "members":{ "rankingData":{ "shape":"RankingData", "documentation":"Details about the content ranking data.
" }, "textData":{ "shape":"TextData", "documentation":"Details about the content text data.
" } }, "documentation":"Details about the content data.
" }, "ContentDisposition":{ "type":"string", "enum":["ATTACHMENT"] }, "ContentFeedbackData":{ "type":"structure", "members":{ "generativeContentFeedbackData":{ "shape":"GenerativeContentFeedbackData", "documentation":"Information about the feedback for a generative target type.
" } }, "documentation":"Information about the feedback.
", "union":true }, "ContentMetadata":{ "type":"map", "key":{"shape":"NonEmptyString"}, "value":{"shape":"NonEmptyString"}, "max":10, "min":0 }, "ContentReference":{ "type":"structure", "members":{ "contentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content.
" }, "contentId":{ "shape":"Uuid", "documentation":"The identifier of the content.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" }, "referenceType":{ "shape":"ReferenceType", "documentation":"The type of reference content.
" }, "sourceURL":{ "shape":"String", "documentation":"The web URL of the source content.
" } }, "documentation":"Reference information about the content.
" }, "ContentStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED" ] }, "ContentSummary":{ "type":"structure", "required":[ "contentArn", "contentId", "contentType", "knowledgeBaseArn", "knowledgeBaseId", "metadata", "name", "revisionId", "status", "title" ], "members":{ "contentArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the content.
" }, "contentId":{ "shape":"Uuid", "documentation":"The identifier of the content.
" }, "contentType":{ "shape":"ContentType", "documentation":"The media type of the content.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" }, "metadata":{ "shape":"ContentMetadata", "documentation":"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.
" }, "name":{ "shape":"Name", "documentation":"The name of the content.
" }, "revisionId":{ "shape":"NonEmptyString", "documentation":"The identifier of the revision of the content.
" }, "status":{ "shape":"ContentStatus", "documentation":"The status of the content.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "title":{ "shape":"ContentTitle", "documentation":"The title of the content.
" } }, "documentation":"Summary information about the content.
" }, "ContentSummaryList":{ "type":"list", "member":{"shape":"ContentSummary"} }, "ContentTitle":{ "type":"string", "max":255, "min":1 }, "ContentType":{ "type":"string", "pattern":"^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" }, "ConversationContext":{ "type":"structure", "required":["selfServiceConversationHistory"], "members":{ "selfServiceConversationHistory":{ "shape":"SelfServiceConversationHistoryList", "documentation":"The self service conversation history before the Amazon Q in Connect session.
" } }, "documentation":"The conversation context to include in SendMessage.
" }, "ConversationState":{ "type":"structure", "required":["status"], "members":{ "reason":{ "shape":"ConversationStatusReason", "documentation":"The reason of the conversation state.
" }, "status":{ "shape":"ConversationStatus", "documentation":"The status of the conversation state.
" } }, "documentation":"The conversation state associated to a message.
" }, "ConversationStatus":{ "type":"string", "enum":[ "CLOSED", "READY", "PROCESSING" ] }, "ConversationStatusReason":{ "type":"string", "enum":[ "SUCCESS", "FAILED", "REJECTED" ] }, "CreateAIAgentRequest":{ "type":"structure", "required":[ "assistantId", "configuration", "name", "type", "visibilityStatus" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "configuration":{ "shape":"AIAgentConfiguration", "documentation":"The configuration of the AI Agent.
" }, "description":{ "shape":"Description", "documentation":"The description of the AI Agent.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Agent.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AIAgentType", "documentation":"The type of the AI Agent.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Agent.
" } } }, "CreateAIAgentResponse":{ "type":"structure", "members":{ "aiAgent":{ "shape":"AIAgentData", "documentation":"The data of the created AI Agent.
" } } }, "CreateAIAgentVersionRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Agent.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "modifiedTime":{ "shape":"Timestamp", "documentation":"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.
" } } }, "CreateAIAgentVersionResponse":{ "type":"structure", "members":{ "aiAgent":{ "shape":"AIAgentData", "documentation":"The data of the AI Agent version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Agent version.
" } } }, "CreateAIGuardrailRequest":{ "type":"structure", "required":[ "assistantId", "blockedInputMessaging", "blockedOutputsMessaging", "name", "visibilityStatus" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "blockedInputMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a prompt.
" }, "blockedOutputsMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a model response.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "contentPolicyConfig":{ "shape":"AIGuardrailContentPolicyConfig", "documentation":"The content filter policies to configure for the AI Guardrail.
" }, "contextualGroundingPolicyConfig":{ "shape":"AIGuardrailContextualGroundingPolicyConfig", "documentation":"The contextual grounding policy configuration used to create an AI Guardrail.
" }, "description":{ "shape":"AIGuardrailDescription", "documentation":"A description of the AI Guardrail.
" }, "name":{ "shape":"Name", "documentation":"The name of the AI Guardrail.
" }, "sensitiveInformationPolicyConfig":{ "shape":"AIGuardrailSensitiveInformationPolicyConfig", "documentation":"The sensitive information policy to configure for the AI Guardrail.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "topicPolicyConfig":{ "shape":"AIGuardrailTopicPolicyConfig", "documentation":"The topic policies to configure for the AI Guardrail.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Guardrail.
" }, "wordPolicyConfig":{ "shape":"AIGuardrailWordPolicyConfig", "documentation":"The word policy you configure for the AI Guardrail.
" } } }, "CreateAIGuardrailResponse":{ "type":"structure", "members":{ "aiGuardrail":{ "shape":"AIGuardrailData", "documentation":"The data of the AI Guardrail.
" } } }, "CreateAIGuardrailVersionRequest":{ "type":"structure", "required":[ "aiGuardrailId", "assistantId" ], "members":{ "aiGuardrailId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Guardrail was last modified.
" } } }, "CreateAIGuardrailVersionResponse":{ "type":"structure", "members":{ "aiGuardrail":{ "shape":"AIGuardrailData", "documentation":"The data of the AI Guardrail version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Guardrail version.
" } } }, "CreateAIPromptRequest":{ "type":"structure", "required":[ "apiFormat", "assistantId", "modelId", "name", "templateConfiguration", "templateType", "type", "visibilityStatus" ], "members":{ "apiFormat":{ "shape":"AIPromptAPIFormat", "documentation":"The API Format of the AI Prompt.
" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"The description of the AI Prompt.
" }, "modelId":{ "shape":"AIPromptModelIdentifier", "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1
The name of the AI Prompt.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "templateConfiguration":{ "shape":"AIPromptTemplateConfiguration", "documentation":"The configuration of the prompt template for this AI Prompt.
" }, "templateType":{ "shape":"AIPromptTemplateType", "documentation":"The type of the prompt template for this AI Prompt.
" }, "type":{ "shape":"AIPromptType", "documentation":"The type of this AI Prompt.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the AI Prompt.
" } } }, "CreateAIPromptResponse":{ "type":"structure", "members":{ "aiPrompt":{ "shape":"AIPromptData", "documentation":"The data of the AI Prompt.
" } } }, "CreateAIPromptVersionRequest":{ "type":"structure", "required":[ "aiPromptId", "assistantId" ], "members":{ "aiPromptId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI prompt.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "modifiedTime":{ "shape":"Timestamp", "documentation":"The time the AI Prompt was last modified.
" } } }, "CreateAIPromptVersionResponse":{ "type":"structure", "members":{ "aiPrompt":{ "shape":"AIPromptData", "documentation":"The data of the AI Prompt version.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Prompt version.
" } } }, "CreateAssistantAssociationRequest":{ "type":"structure", "required":[ "assistantId", "association", "associationType" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "association":{ "shape":"AssistantAssociationInputData", "documentation":"The identifier of the associated resource.
" }, "associationType":{ "shape":"AssociationType", "documentation":"The type of association.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "CreateAssistantAssociationResponse":{ "type":"structure", "members":{ "assistantAssociation":{ "shape":"AssistantAssociationData", "documentation":"The assistant association.
" } } }, "CreateAssistantRequest":{ "type":"structure", "required":[ "name", "type" ], "members":{ "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"The description of the assistant.
" }, "name":{ "shape":"Name", "documentation":"The name of the assistant.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "type":{ "shape":"AssistantType", "documentation":"The type of assistant.
" } } }, "CreateAssistantResponse":{ "type":"structure", "members":{ "assistant":{ "shape":"AssistantData", "documentation":"Information about the assistant.
" } } }, "CreateContentAssociationRequest":{ "type":"structure", "required":[ "association", "associationType", "contentId", "knowledgeBaseId" ], "members":{ "association":{ "shape":"ContentAssociationContents", "documentation":"The identifier of the associated resource.
" }, "associationType":{ "shape":"ContentAssociationType", "documentation":"The type of association.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "CreateContentAssociationResponse":{ "type":"structure", "members":{ "contentAssociation":{ "shape":"ContentAssociationData", "documentation":"The association between Amazon Q in Connect content and another resource.
" } } }, "CreateContentRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "name", "uploadId" ], "members":{ "clientToken":{ "shape":"NonEmptyString", "documentation":"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.
", "idempotencyToken":true }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" }, "metadata":{ "shape":"ContentMetadata", "documentation":"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.
" }, "name":{ "shape":"Name", "documentation":"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.
" }, "overrideLinkOutUri":{ "shape":"Uri", "documentation":"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.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "title":{ "shape":"ContentTitle", "documentation":"The title of the content. If not set, the title is equal to the name.
" }, "uploadId":{ "shape":"UploadId", "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } } }, "CreateContentResponse":{ "type":"structure", "members":{ "content":{ "shape":"ContentData", "documentation":"The content.
" } } }, "CreateKnowledgeBaseRequest":{ "type":"structure", "required":[ "knowledgeBaseType", "name" ], "members":{ "clientToken":{ "shape":"NonEmptyString", "documentation":"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.
", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"The description.
" }, "knowledgeBaseType":{ "shape":"KnowledgeBaseType", "documentation":"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.
" }, "name":{ "shape":"Name", "documentation":"The name of the knowledge base.
" }, "renderingConfiguration":{ "shape":"RenderingConfiguration", "documentation":"Information about how to render the content.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "sourceConfiguration":{ "shape":"SourceConfiguration", "documentation":"The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "vectorIngestionConfiguration":{ "shape":"VectorIngestionConfiguration", "documentation":"Contains details about how to ingest the documents in a data source.
" } } }, "CreateKnowledgeBaseResponse":{ "type":"structure", "members":{ "knowledgeBase":{ "shape":"KnowledgeBaseData", "documentation":"The knowledge base.
" } } }, "CreateMessageTemplateAttachmentRequest":{ "type":"structure", "required":[ "body", "contentDisposition", "knowledgeBaseId", "messageTemplateId", "name" ], "members":{ "body":{ "shape":"NonEmptyUnlimitedString", "documentation":"The body of the attachment file being uploaded. It should be encoded using base64 encoding.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
" }, "contentDisposition":{ "shape":"ContentDisposition", "documentation":"The presentation information for the attachment file.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" }, "name":{ "shape":"AttachmentFileName", "documentation":"The name of the attachment file being uploaded. The name should include the file extension.
" } } }, "CreateMessageTemplateAttachmentResponse":{ "type":"structure", "members":{ "attachment":{ "shape":"MessageTemplateAttachment", "documentation":"The message template attachment.
" } } }, "CreateMessageTemplateRequest":{ "type":"structure", "required":[ "channelSubtype", "content", "knowledgeBaseId", "name" ], "members":{ "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "content":{ "shape":"MessageTemplateContentProvider", "documentation":"The content of the message template.
" }, "defaultAttributes":{ "shape":"MessageTemplateAttributes", "documentation":"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.
" }, "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "groupingConfiguration":{"shape":"GroupingConfiguration"}, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "language":{ "shape":"LanguageCode", "documentation":"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 name of the message template.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "CreateMessageTemplateResponse":{ "type":"structure", "members":{ "messageTemplate":{ "shape":"MessageTemplateData", "documentation":"The message template.
" } } }, "CreateMessageTemplateVersionRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateContentSha256":{ "shape":"MessageTemplateContentSha256", "documentation":"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 identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" } } }, "CreateMessageTemplateVersionResponse":{ "type":"structure", "members":{ "messageTemplate":{ "shape":"ExtendedMessageTemplateData", "documentation":"The message template.
" } } }, "CreateQuickResponseRequest":{ "type":"structure", "required":[ "content", "knowledgeBaseId", "name" ], "members":{ "channels":{ "shape":"Channels", "documentation":"The Amazon Connect channels this quick response applies to.
" }, "clientToken":{ "shape":"NonEmptyString", "documentation":"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.
", "idempotencyToken":true }, "content":{ "shape":"QuickResponseDataProvider", "documentation":"The content of the quick response.
" }, "contentType":{ "shape":"QuickResponseType", "documentation":"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 description of the quick response.
" }, "groupingConfiguration":{ "shape":"GroupingConfiguration", "documentation":"The configuration information of the user groups that the quick response is accessible to.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the quick response is active.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "language":{ "shape":"LanguageCode", "documentation":"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 name of the quick response.
" }, "shortcutKey":{ "shape":"ShortCutKey", "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "CreateQuickResponseResponse":{ "type":"structure", "members":{ "quickResponse":{ "shape":"QuickResponseData", "documentation":"The quick response.
" } } }, "CreateSessionRequest":{ "type":"structure", "required":[ "assistantId", "name" ], "members":{ "aiAgentConfiguration":{ "shape":"AIAgentConfigurationMap", "documentation":"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.
" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"The description.
" }, "name":{ "shape":"Name", "documentation":"The name of the session.
" }, "tagFilter":{ "shape":"TagFilter", "documentation":"An object that can be used to specify Tag conditions.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "CreateSessionResponse":{ "type":"structure", "members":{ "session":{ "shape":"SessionData", "documentation":"The session.
" } } }, "CustomAttributes":{ "type":"map", "key":{"shape":"MessageTemplateAttributeKey"}, "value":{"shape":"MessageTemplateAttributeValue"}, "sensitive":true }, "CustomerProfileAttributes":{ "type":"structure", "members":{ "accountNumber":{ "shape":"MessageTemplateAttributeValue", "documentation":"A unique account number that you have given to the customer.
" }, "additionalInformation":{ "shape":"MessageTemplateAttributeValue", "documentation":"Any additional information relevant to the customer's profile.
" }, "address1":{ "shape":"MessageTemplateAttributeValue", "documentation":"The first line of a customer address.
" }, "address2":{ "shape":"MessageTemplateAttributeValue", "documentation":"The second line of a customer address.
" }, "address3":{ "shape":"MessageTemplateAttributeValue", "documentation":"The third line of a customer address.
" }, "address4":{ "shape":"MessageTemplateAttributeValue", "documentation":"The fourth line of a customer address.
" }, "billingAddress1":{ "shape":"MessageTemplateAttributeValue", "documentation":"The first line of a customer’s billing address.
" }, "billingAddress2":{ "shape":"MessageTemplateAttributeValue", "documentation":"The second line of a customer’s billing address.
" }, "billingAddress3":{ "shape":"MessageTemplateAttributeValue", "documentation":"The third line of a customer’s billing address.
" }, "billingAddress4":{ "shape":"MessageTemplateAttributeValue", "documentation":"The fourth line of a customer’s billing address.
" }, "billingCity":{ "shape":"MessageTemplateAttributeValue", "documentation":"The city of a customer’s billing address.
" }, "billingCountry":{ "shape":"MessageTemplateAttributeValue", "documentation":"The country of a customer’s billing address.
" }, "billingCounty":{ "shape":"MessageTemplateAttributeValue", "documentation":"The county of a customer’s billing address.
" }, "billingPostalCode":{ "shape":"MessageTemplateAttributeValue", "documentation":"The postal code of a customer’s billing address.
" }, "billingProvince":{ "shape":"MessageTemplateAttributeValue", "documentation":"The province of a customer’s billing address.
" }, "billingState":{ "shape":"MessageTemplateAttributeValue", "documentation":"The state of a customer’s billing address.
" }, "birthDate":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's birth date.
" }, "businessEmailAddress":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's business email address.
" }, "businessName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The name of the customer's business.
" }, "businessPhoneNumber":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's business phone number.
" }, "city":{ "shape":"MessageTemplateAttributeValue", "documentation":"The city in which a customer lives.
" }, "country":{ "shape":"MessageTemplateAttributeValue", "documentation":"The country in which a customer lives.
" }, "county":{ "shape":"MessageTemplateAttributeValue", "documentation":"The county in which a customer lives.
" }, "custom":{ "shape":"CustomAttributes", "documentation":"The custom attributes in customer profile attributes.
" }, "emailAddress":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's email address, which has not been specified as a personal or business address.
" }, "firstName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's first name.
" }, "gender":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's gender.
" }, "homePhoneNumber":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's mobile phone number.
" }, "lastName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's last name.
" }, "mailingAddress1":{ "shape":"MessageTemplateAttributeValue", "documentation":"The first line of a customer’s mailing address.
" }, "mailingAddress2":{ "shape":"MessageTemplateAttributeValue", "documentation":"The second line of a customer’s mailing address.
" }, "mailingAddress3":{ "shape":"MessageTemplateAttributeValue", "documentation":"The third line of a customer’s mailing address.
" }, "mailingAddress4":{ "shape":"MessageTemplateAttributeValue", "documentation":"The fourth line of a customer’s mailing address.
" }, "mailingCity":{ "shape":"MessageTemplateAttributeValue", "documentation":"The city of a customer’s mailing address.
" }, "mailingCountry":{ "shape":"MessageTemplateAttributeValue", "documentation":"The country of a customer’s mailing address.
" }, "mailingCounty":{ "shape":"MessageTemplateAttributeValue", "documentation":"The county of a customer’s mailing address.
" }, "mailingPostalCode":{ "shape":"MessageTemplateAttributeValue", "documentation":"The postal code of a customer’s mailing address.
" }, "mailingProvince":{ "shape":"MessageTemplateAttributeValue", "documentation":"The province of a customer’s mailing address.
" }, "mailingState":{ "shape":"MessageTemplateAttributeValue", "documentation":"The state of a customer’s mailing address.
" }, "middleName":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's middle name.
" }, "mobilePhoneNumber":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's mobile phone number.
" }, "partyType":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's party type.
" }, "phoneNumber":{ "shape":"MessageTemplateAttributeValue", "documentation":"The customer's phone number, which has not been specified as a mobile, home, or business number.
" }, "postalCode":{ "shape":"MessageTemplateAttributeValue", "documentation":"The postal code of a customer address.
" }, "profileARN":{ "shape":"MessageTemplateAttributeValue", "documentation":"The ARN of a customer profile.
" }, "profileId":{ "shape":"MessageTemplateAttributeValue", "documentation":"The unique identifier of a customer profile.
" }, "province":{ "shape":"MessageTemplateAttributeValue", "documentation":"The province in which a customer lives.
" }, "shippingAddress1":{ "shape":"MessageTemplateAttributeValue", "documentation":"The first line of a customer’s shipping address.
" }, "shippingAddress2":{ "shape":"MessageTemplateAttributeValue", "documentation":"The second line of a customer’s shipping address.
" }, "shippingAddress3":{ "shape":"MessageTemplateAttributeValue", "documentation":"The third line of a customer’s shipping address.
" }, "shippingAddress4":{ "shape":"MessageTemplateAttributeValue", "documentation":"The fourth line of a customer’s shipping address.
" }, "shippingCity":{ "shape":"MessageTemplateAttributeValue", "documentation":"The city of a customer’s shipping address.
" }, "shippingCountry":{ "shape":"MessageTemplateAttributeValue", "documentation":"The country of a customer’s shipping address.
" }, "shippingCounty":{ "shape":"MessageTemplateAttributeValue", "documentation":"The county of a customer’s shipping address.
" }, "shippingPostalCode":{ "shape":"MessageTemplateAttributeValue", "documentation":"The postal code of a customer’s shipping address.
" }, "shippingProvince":{ "shape":"MessageTemplateAttributeValue", "documentation":"The province of a customer’s shipping address.
" }, "shippingState":{ "shape":"MessageTemplateAttributeValue", "documentation":"The state of a customer’s shipping address.
" }, "state":{ "shape":"MessageTemplateAttributeValue", "documentation":"The state in which a customer lives.
" } }, "documentation":"The customer profile attributes that are used with the message template.
" }, "DataDetails":{ "type":"structure", "members":{ "contentData":{ "shape":"ContentDataDetails", "documentation":"Details about the content data.
" }, "generativeData":{ "shape":"GenerativeDataDetails", "documentation":"Details about the generative data.
" }, "intentDetectedData":{ "shape":"IntentDetectedDataDetails", "documentation":"Details about the intent data.
" }, "sourceContentData":{ "shape":"SourceContentDataDetails", "documentation":"Details about the content data.
" } }, "documentation":"Details about the data.
", "union":true }, "DataReference":{ "type":"structure", "members":{ "contentReference":{"shape":"ContentReference"}, "generativeReference":{ "shape":"GenerativeReference", "documentation":"Reference information about the generative content.
" } }, "documentation":"Reference data.
", "union":true }, "DataSummary":{ "type":"structure", "required":[ "details", "reference" ], "members":{ "details":{ "shape":"DataDetails", "documentation":"Details about the data.
" }, "reference":{ "shape":"DataReference", "documentation":"Reference information about the content.
" } }, "documentation":"Summary of the data.
" }, "DataSummaryList":{ "type":"list", "member":{"shape":"DataSummary"} }, "DeactivateMessageTemplateRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId", "versionNumber" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version to deactivate.
" } } }, "DeactivateMessageTemplateResponse":{ "type":"structure", "required":[ "messageTemplateArn", "messageTemplateId", "versionNumber" ], "members":{ "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateId":{ "shape":"Uuid", "documentation":"The identifier of the message template.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version that has been deactivated.
" } } }, "DeleteAIAgentRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "DeleteAIAgentResponse":{ "type":"structure", "members":{ } }, "DeleteAIAgentVersionRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId", "versionNumber" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Agent version.
", "location":"uri", "locationName":"versionNumber" } } }, "DeleteAIAgentVersionResponse":{ "type":"structure", "members":{ } }, "DeleteAIGuardrailRequest":{ "type":"structure", "required":[ "aiGuardrailId", "assistantId" ], "members":{ "aiGuardrailId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "DeleteAIGuardrailResponse":{ "type":"structure", "members":{ } }, "DeleteAIGuardrailVersionRequest":{ "type":"structure", "required":[ "aiGuardrailId", "assistantId", "versionNumber" ], "members":{ "aiGuardrailId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Guardrail version to be deleted.
", "location":"uri", "locationName":"versionNumber" } } }, "DeleteAIGuardrailVersionResponse":{ "type":"structure", "members":{ } }, "DeleteAIPromptRequest":{ "type":"structure", "required":[ "aiPromptId", "assistantId" ], "members":{ "aiPromptId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "DeleteAIPromptResponse":{ "type":"structure", "members":{ } }, "DeleteAIPromptVersionRequest":{ "type":"structure", "required":[ "aiPromptId", "assistantId", "versionNumber" ], "members":{ "aiPromptId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI prompt.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the AI Prompt version to be deleted.
", "location":"uri", "locationName":"versionNumber" } } }, "DeleteAIPromptVersionResponse":{ "type":"structure", "members":{ } }, "DeleteAssistantAssociationRequest":{ "type":"structure", "required":[ "assistantAssociationId", "assistantId" ], "members":{ "assistantAssociationId":{ "shape":"UuidOrArn", "documentation":"The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantAssociationId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "DeleteAssistantAssociationResponse":{ "type":"structure", "members":{ } }, "DeleteAssistantRequest":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "DeleteAssistantResponse":{ "type":"structure", "members":{ } }, "DeleteContentAssociationRequest":{ "type":"structure", "required":[ "contentAssociationId", "contentId", "knowledgeBaseId" ], "members":{ "contentAssociationId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentAssociationId" }, "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "DeleteContentAssociationResponse":{ "type":"structure", "members":{ } }, "DeleteContentRequest":{ "type":"structure", "required":[ "contentId", "knowledgeBaseId" ], "members":{ "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "DeleteContentResponse":{ "type":"structure", "members":{ } }, "DeleteImportJobRequest":{ "type":"structure", "required":[ "importJobId", "knowledgeBaseId" ], "members":{ "importJobId":{ "shape":"Uuid", "documentation":"The identifier of the import job to be deleted.
", "location":"uri", "locationName":"importJobId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "DeleteImportJobResponse":{ "type":"structure", "members":{ } }, "DeleteKnowledgeBaseRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "DeleteKnowledgeBaseResponse":{ "type":"structure", "members":{ } }, "DeleteMessageTemplateAttachmentRequest":{ "type":"structure", "required":[ "attachmentId", "knowledgeBaseId", "messageTemplateId" ], "members":{ "attachmentId":{ "shape":"Uuid", "documentation":"The identifier of the attachment file.
", "location":"uri", "locationName":"attachmentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" } } }, "DeleteMessageTemplateAttachmentResponse":{ "type":"structure", "members":{ } }, "DeleteMessageTemplateRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", "location":"uri", "locationName":"messageTemplateId" } } }, "DeleteMessageTemplateResponse":{ "type":"structure", "members":{ } }, "DeleteQuickResponseRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "quickResponseId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" }, "quickResponseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the quick response to delete.
", "location":"uri", "locationName":"quickResponseId" } } }, "DeleteQuickResponseResponse":{ "type":"structure", "members":{ } }, "Description":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9\\s_.,-]+" }, "Document":{ "type":"structure", "required":["contentReference"], "members":{ "contentReference":{ "shape":"ContentReference", "documentation":"A reference to the content resource.
" }, "excerpt":{ "shape":"DocumentText", "documentation":"The excerpt from the document.
" }, "title":{ "shape":"DocumentText", "documentation":"The title of the document.
" } }, "documentation":"The document.
" }, "DocumentText":{ "type":"structure", "members":{ "highlights":{ "shape":"Highlights", "documentation":"Highlights in the document text.
" }, "text":{ "shape":"SensitiveString", "documentation":"Text in the document.
" } }, "documentation":"The text of the document.
" }, "EmailHeader":{ "type":"structure", "members":{ "name":{ "shape":"EmailHeaderKey", "documentation":"The name of the email header.
" }, "value":{ "shape":"EmailHeaderValue", "documentation":"The value of the email header.
" } }, "documentation":"The email header to include in email messages.
" }, "EmailHeaderKey":{ "type":"string", "max":126, "min":1, "pattern":"^[!-9;-@A-~]+$" }, "EmailHeaderValue":{ "type":"string", "max":870, "min":1, "pattern":"[ -~]*", "sensitive":true }, "EmailHeaders":{ "type":"list", "member":{"shape":"EmailHeader"}, "max":15, "min":0 }, "EmailMessageTemplateContent":{ "type":"structure", "members":{ "body":{ "shape":"EmailMessageTemplateContentBody", "documentation":"The body to use in email messages.
" }, "headers":{ "shape":"EmailHeaders", "documentation":"The email headers to include in email messages.
" }, "subject":{ "shape":"NonEmptyUnlimitedString", "documentation":"The subject line, or title, to use in email messages.
" } }, "documentation":"The content of the message template that applies to the email channel subtype.
" }, "EmailMessageTemplateContentBody":{ "type":"structure", "members":{ "html":{ "shape":"MessageTemplateBodyContentProvider", "documentation":"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.
" }, "plainText":{ "shape":"MessageTemplateBodyContentProvider", "documentation":"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.
" } }, "documentation":"The body to use in email messages.
" }, "ExtendedMessageTemplateData":{ "type":"structure", "required":[ "channelSubtype", "content", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedBy", "lastModifiedTime", "messageTemplateArn", "messageTemplateContentSha256", "messageTemplateId", "name" ], "members":{ "attachments":{ "shape":"MessageTemplateAttachmentList", "documentation":"The message template attachments.
" }, "attributeTypes":{ "shape":"MessageTemplateAttributeTypeList", "documentation":"The types of attributes contain the message template.
" }, "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "content":{ "shape":"MessageTemplateContentProvider", "documentation":"The content of the message template.
" }, "createdTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template was created.
" }, "defaultAttributes":{ "shape":"MessageTemplateAttributes", "documentation":"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.
" }, "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "groupingConfiguration":{"shape":"GroupingConfiguration"}, "isActive":{ "shape":"Boolean", "documentation":"Whether the version of the message template is activated.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "language":{ "shape":"LanguageCode", "documentation":"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 Amazon Resource Name (ARN) of the user who last updated the message template data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template data was last modified.
" }, "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateContentSha256":{ "shape":"MessageTemplateContentSha256", "documentation":"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 identifier of the message template.
" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version.
" } }, "documentation":"The extended data of a message template.
" }, "ExternalSource":{ "type":"string", "enum":["AMAZON_CONNECT"] }, "ExternalSourceConfiguration":{ "type":"structure", "required":[ "configuration", "source" ], "members":{ "configuration":{ "shape":"Configuration", "documentation":"The configuration information of the external data source.
" }, "source":{ "shape":"ExternalSource", "documentation":"The type of the external data source.
" } }, "documentation":"The configuration information of the external data source.
" }, "FailureReason":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "Filter":{ "type":"structure", "required":[ "field", "operator", "value" ], "members":{ "field":{ "shape":"FilterField", "documentation":"The field on which to filter.
" }, "operator":{ "shape":"FilterOperator", "documentation":"The operator to use for comparing the field’s value with the provided value.
" }, "value":{ "shape":"NonEmptyString", "documentation":"The desired field value on which to filter.
" } }, "documentation":"A search filter.
" }, "FilterField":{ "type":"string", "enum":["NAME"] }, "FilterList":{ "type":"list", "member":{"shape":"Filter"} }, "FilterOperator":{ "type":"string", "enum":["EQUALS"] }, "FixedSizeChunkingConfiguration":{ "type":"structure", "required":[ "maxTokens", "overlapPercentage" ], "members":{ "maxTokens":{ "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", "documentation":"The maximum number of tokens to include in a chunk.
" }, "overlapPercentage":{ "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", "documentation":"The percentage of overlap between adjacent chunks of a data source.
" } }, "documentation":"Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The relevance of the feedback.
" } }, "documentation":"The feedback information for a generative target type.
" }, "GenerativeDataDetails":{ "type":"structure", "required":[ "completion", "rankingData", "references" ], "members":{ "completion":{ "shape":"SensitiveString", "documentation":"The LLM response.
" }, "rankingData":{ "shape":"RankingData", "documentation":"Details about the generative content ranking data.
" }, "references":{ "shape":"DataSummaryList", "documentation":"The references used to generative the LLM response.
" } }, "documentation":"Details about generative data.
" }, "GenerativeReference":{ "type":"structure", "members":{ "generationId":{ "shape":"Uuid", "documentation":"The identifier of the LLM model.
" }, "modelId":{ "shape":"LlmModelId", "documentation":"The identifier of the LLM model.
" } }, "documentation":"Reference information about generative content.
" }, "GenericArn":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" }, "GetAIAgentRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"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.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "GetAIAgentResponse":{ "type":"structure", "members":{ "aiAgent":{ "shape":"AIAgentData", "documentation":"The data of the AI Agent.
" }, "versionNumber":{ "shape":"Version", "documentation":"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 identifier of the Amazon Q in Connect AI Guardrail.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "GetAIGuardrailResponse":{ "type":"structure", "members":{ "aiGuardrail":{ "shape":"AIGuardrailData", "documentation":"The data of the AI Guardrail.
" }, "versionNumber":{ "shape":"Version", "documentation":"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 identifier of the Amazon Q in Connect AI prompt.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "GetAIPromptResponse":{ "type":"structure", "members":{ "aiPrompt":{ "shape":"AIPromptData", "documentation":"The data of the AI Prompt.
" }, "versionNumber":{ "shape":"Version", "documentation":"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 identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantAssociationId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "GetAssistantAssociationResponse":{ "type":"structure", "members":{ "assistantAssociation":{ "shape":"AssistantAssociationData", "documentation":"The assistant association.
" } } }, "GetAssistantRequest":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "GetAssistantResponse":{ "type":"structure", "members":{ "assistant":{ "shape":"AssistantData", "documentation":"Information about the assistant.
" } } }, "GetContentAssociationRequest":{ "type":"structure", "required":[ "contentAssociationId", "contentId", "knowledgeBaseId" ], "members":{ "contentAssociationId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentAssociationId" }, "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "GetContentAssociationResponse":{ "type":"structure", "members":{ "contentAssociation":{ "shape":"ContentAssociationData", "documentation":"The association between Amazon Q in Connect content and another resource.
" } } }, "GetContentRequest":{ "type":"structure", "required":[ "contentId", "knowledgeBaseId" ], "members":{ "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "GetContentResponse":{ "type":"structure", "members":{ "content":{ "shape":"ContentData", "documentation":"The content.
" } } }, "GetContentSummaryRequest":{ "type":"structure", "required":[ "contentId", "knowledgeBaseId" ], "members":{ "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "GetContentSummaryResponse":{ "type":"structure", "members":{ "contentSummary":{ "shape":"ContentSummary", "documentation":"The content summary.
" } } }, "GetImportJobRequest":{ "type":"structure", "required":[ "importJobId", "knowledgeBaseId" ], "members":{ "importJobId":{ "shape":"Uuid", "documentation":"The identifier of the import job to retrieve.
", "location":"uri", "locationName":"importJobId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base that the import job belongs to.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "GetImportJobResponse":{ "type":"structure", "members":{ "importJob":{ "shape":"ImportJobData", "documentation":"The import job.
" } } }, "GetKnowledgeBaseRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "GetKnowledgeBaseResponse":{ "type":"structure", "members":{ "knowledgeBase":{ "shape":"KnowledgeBaseData", "documentation":"The knowledge base.
" } } }, "GetMessageTemplateRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", "location":"uri", "locationName":"messageTemplateId" } } }, "GetMessageTemplateResponse":{ "type":"structure", "members":{ "messageTemplate":{ "shape":"ExtendedMessageTemplateData", "documentation":"The message template.
" } } }, "GetNextMessageRequest":{ "type":"structure", "required":[ "assistantId", "nextMessageToken", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant.
", "location":"uri", "locationName":"assistantId" }, "nextMessageToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextMessageToken" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect session.
", "location":"uri", "locationName":"sessionId" } } }, "GetNextMessageResponse":{ "type":"structure", "required":[ "conversationState", "requestMessageId", "response", "type" ], "members":{ "conversationSessionData":{ "shape":"RuntimeSessionDataList", "documentation":"The conversation data stored on an Amazon Q in Connect Session.
" }, "conversationState":{ "shape":"ConversationState", "documentation":"The state of current conversation.
" }, "nextMessageToken":{ "shape":"NextToken", "documentation":"The token for the next message.
" }, "requestMessageId":{ "shape":"Uuid", "documentation":"The identifier of the submitted message.
" }, "response":{ "shape":"MessageOutput", "documentation":"The message response to the requested message.
" }, "type":{ "shape":"MessageType", "documentation":"The type of message response.
" } } }, "GetQuickResponseRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "quickResponseId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" }, "quickResponseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the quick response.
", "location":"uri", "locationName":"quickResponseId" } } }, "GetQuickResponseResponse":{ "type":"structure", "members":{ "quickResponse":{ "shape":"QuickResponseData", "documentation":"The quick response.
" } } }, "GetRecommendationsRequest":{ "type":"structure", "required":[ "assistantId", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"sessionId" }, "waitTimeSeconds":{ "shape":"WaitTimeSeconds", "documentation":"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 recommendations.
" }, "triggers":{ "shape":"RecommendationTriggerList", "documentation":"The triggers corresponding to recommendations.
" } } }, "GetSessionRequest":{ "type":"structure", "required":[ "assistantId", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"sessionId" } } }, "GetSessionResponse":{ "type":"structure", "members":{ "session":{ "shape":"SessionData", "documentation":"The session.
" } } }, "GroupingConfiguration":{ "type":"structure", "members":{ "criteria":{ "shape":"GroupingCriteria", "documentation":"The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
The configuration information of the grouping of Amazon Q in Connect users.
" }, "GroupingCriteria":{ "type":"string", "max":100, "min":1, "sensitive":true }, "GroupingValue":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "GroupingValues":{ "type":"list", "member":{"shape":"GroupingValue"} }, "GuardrailContentFilterConfig":{ "type":"structure", "required":[ "inputStrength", "outputStrength", "type" ], "members":{ "inputStrength":{ "shape":"GuardrailFilterStrength", "documentation":"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.
" }, "outputStrength":{ "shape":"GuardrailFilterStrength", "documentation":"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.
" }, "type":{ "shape":"GuardrailContentFilterType", "documentation":"The harmful category that the content filter is applied to.
" } }, "documentation":"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.
" }, "GuardrailContentFilterType":{ "type":"string", "documentation":"Type of text to text filter in content policy
", "enum":[ "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK" ], "sensitive":true }, "GuardrailContentFiltersConfig":{ "type":"list", "member":{"shape":"GuardrailContentFilterConfig"}, "documentation":"List of content filter configs in content policy.
", "max":6, "min":1 }, "GuardrailContextualGroundingFilterConfig":{ "type":"structure", "required":[ "threshold", "type" ], "members":{ "threshold":{ "shape":"GuardrailContextualGroundingFilterThreshold", "documentation":"The threshold details for the AI Guardrail's contextual grounding filter.
" }, "type":{ "shape":"GuardrailContextualGroundingFilterType", "documentation":"The filter type for the AI Guardrail's contextual grounding filter.
" } }, "documentation":"The filter configuration details for the AI Guardrail's contextual grounding filter.
" }, "GuardrailContextualGroundingFilterThreshold":{ "type":"double", "documentation":"The threshold for this filter.
", "min":0, "sensitive":true }, "GuardrailContextualGroundingFilterType":{ "type":"string", "documentation":"Type of contextual grounding filter
", "enum":[ "GROUNDING", "RELEVANCE" ], "sensitive":true }, "GuardrailContextualGroundingFiltersConfig":{ "type":"list", "member":{"shape":"GuardrailContextualGroundingFilterConfig"}, "documentation":"List of contextual grounding filter configs.
", "min":1 }, "GuardrailFilterStrength":{ "type":"string", "documentation":"Strength for filters
", "enum":[ "NONE", "LOW", "MEDIUM", "HIGH" ], "sensitive":true }, "GuardrailManagedWordListsConfig":{ "type":"list", "member":{"shape":"GuardrailManagedWordsConfig"}, "documentation":"A config for the list of managed words.
" }, "GuardrailManagedWordsConfig":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"GuardrailManagedWordsType", "documentation":"The managed word type to configure for the AI Guardrail.
" } }, "documentation":"The managed word list to configure for the AI Guardrail.
" }, "GuardrailManagedWordsType":{ "type":"string", "documentation":"Options for managed words.
", "enum":["PROFANITY"], "sensitive":true }, "GuardrailPiiEntitiesConfig":{ "type":"list", "member":{"shape":"GuardrailPiiEntityConfig"}, "documentation":"List of entities.
", "min":1 }, "GuardrailPiiEntityConfig":{ "type":"structure", "required":[ "action", "type" ], "members":{ "action":{ "shape":"GuardrailSensitiveInformationAction", "documentation":"Configure AI Guardrail's action when the PII entity is detected.
" }, "type":{ "shape":"GuardrailPiiEntityType", "documentation":"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 PII entity to configure for the AI Guardrail.
" }, "GuardrailPiiEntityType":{ "type":"string", "documentation":"The currently supported PII entities
", "enum":[ "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER" ], "sensitive":true }, "GuardrailRegexConfig":{ "type":"structure", "required":[ "action", "name", "pattern" ], "members":{ "action":{ "shape":"GuardrailSensitiveInformationAction", "documentation":"The AI Guardrail action to configure when matching regular expression is detected.
" }, "description":{ "shape":"GuardrailRegexDescription", "documentation":"The description of the regular expression to configure for the AI Guardrail.
" }, "name":{ "shape":"GuardrailRegexName", "documentation":"The name of the regular expression to configure for the AI Guardrail.
" }, "pattern":{ "shape":"GuardrailRegexPattern", "documentation":"The regular expression pattern to configure for the AI Guardrail.
" } }, "documentation":"The regular expression to configure for the AI Guardrail.
" }, "GuardrailRegexDescription":{ "type":"string", "documentation":"The regex description.
", "max":1000, "min":1, "sensitive":true }, "GuardrailRegexName":{ "type":"string", "documentation":"The regex name.
", "max":100, "min":1, "sensitive":true }, "GuardrailRegexPattern":{ "type":"string", "documentation":"The regex pattern.
", "min":1, "sensitive":true }, "GuardrailRegexesConfig":{ "type":"list", "member":{"shape":"GuardrailRegexConfig"}, "documentation":"List of regex.
", "min":1 }, "GuardrailSensitiveInformationAction":{ "type":"string", "documentation":"Options for sensitive information action.
", "enum":[ "BLOCK", "ANONYMIZE" ], "sensitive":true }, "GuardrailTopicConfig":{ "type":"structure", "required":[ "definition", "name", "type" ], "members":{ "definition":{ "shape":"GuardrailTopicDefinition", "documentation":"A definition of the topic to deny.
" }, "examples":{ "shape":"GuardrailTopicExamples", "documentation":"A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
" }, "name":{ "shape":"GuardrailTopicName", "documentation":"The name of the topic to deny.
" }, "type":{ "shape":"GuardrailTopicType", "documentation":"Specifies to deny the topic.
" } }, "documentation":"Details about topics for the AI Guardrail to identify and deny.
" }, "GuardrailTopicDefinition":{ "type":"string", "documentation":"Definition of topic in topic policy
", "max":200, "min":1, "sensitive":true }, "GuardrailTopicExample":{ "type":"string", "documentation":"Text example in topic policy
", "max":100, "min":1, "sensitive":true }, "GuardrailTopicExamples":{ "type":"list", "member":{"shape":"GuardrailTopicExample"}, "documentation":"List of text examples
", "min":0 }, "GuardrailTopicName":{ "type":"string", "documentation":"Name of topic in topic policy
", "max":100, "min":1, "pattern":"^[0-9a-zA-Z-_ !?.]+$", "sensitive":true }, "GuardrailTopicType":{ "type":"string", "documentation":"Type of topic in a policy
", "enum":["DENY"], "sensitive":true }, "GuardrailTopicsConfig":{ "type":"list", "member":{"shape":"GuardrailTopicConfig"}, "documentation":"List of topic configs in topic policy.
", "min":1 }, "GuardrailWordConfig":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"GuardrailWordText", "documentation":"Text of the word configured for the AI Guardrail to block.
" } }, "documentation":"A word to configure for the AI Guardrail.
" }, "GuardrailWordText":{ "type":"string", "documentation":"The custom word text.
", "min":1, "sensitive":true }, "GuardrailWordsConfig":{ "type":"list", "member":{"shape":"GuardrailWordConfig"}, "documentation":"List of custom word configs.
", "min":1 }, "Headers":{ "type":"map", "key":{"shape":"NonEmptyString"}, "value":{"shape":"NonEmptyString"} }, "HierarchicalChunkingConfiguration":{ "type":"structure", "required":[ "levelConfigurations", "overlapTokens" ], "members":{ "levelConfigurations":{ "shape":"HierarchicalChunkingLevelConfigurations", "documentation":"Token settings for each layer.
" }, "overlapTokens":{ "shape":"HierarchicalChunkingConfigurationOverlapTokensInteger", "documentation":"The number of tokens to repeat across chunks in the same layer.
" } }, "documentation":"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":{ "type":"integer", "box":true, "min":1 }, "HierarchicalChunkingLevelConfiguration":{ "type":"structure", "required":["maxTokens"], "members":{ "maxTokens":{ "shape":"HierarchicalChunkingLevelConfigurationMaxTokensInteger", "documentation":"The maximum number of tokens that a chunk can contain in this layer.
" } }, "documentation":"Token settings for each layer.
" }, "HierarchicalChunkingLevelConfigurationMaxTokensInteger":{ "type":"integer", "box":true, "max":8192, "min":1 }, "HierarchicalChunkingLevelConfigurations":{ "type":"list", "member":{"shape":"HierarchicalChunkingLevelConfiguration"}, "max":2, "min":2 }, "Highlight":{ "type":"structure", "members":{ "beginOffsetInclusive":{ "shape":"HighlightOffset", "documentation":"The offset for the start of the highlight.
" }, "endOffsetExclusive":{ "shape":"HighlightOffset", "documentation":"The offset for the end of the highlight.
" } }, "documentation":"Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
" }, "HighlightOffset":{"type":"integer"}, "Highlights":{ "type":"list", "member":{"shape":"Highlight"} }, "ImportJobData":{ "type":"structure", "required":[ "createdTime", "importJobId", "importJobType", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedTime", "status", "uploadId", "url", "urlExpiry" ], "members":{ "createdTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the import job was created.
" }, "externalSourceConfiguration":{"shape":"ExternalSourceConfiguration"}, "failedRecordReport":{ "shape":"Url", "documentation":"The link to download the information of resource data that failed to be imported.
" }, "importJobId":{ "shape":"Uuid", "documentation":"The identifier of the import job.
" }, "importJobType":{ "shape":"ImportJobType", "documentation":"The type of the import job.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the import job data was last modified.
" }, "metadata":{ "shape":"ContentMetadata", "documentation":"The metadata fields of the imported Amazon Q in Connect resources.
" }, "status":{ "shape":"ImportJobStatus", "documentation":"The status of the import job.
" }, "uploadId":{ "shape":"UploadId", "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" }, "url":{ "shape":"Url", "documentation":"The download link to the resource file that is uploaded to the import job.
" }, "urlExpiry":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The expiration time of the URL as an epoch timestamp.
" } }, "documentation":"Summary information about the import job.
" }, "ImportJobList":{ "type":"list", "member":{"shape":"ImportJobSummary"} }, "ImportJobStatus":{ "type":"string", "enum":[ "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED" ] }, "ImportJobSummary":{ "type":"structure", "required":[ "createdTime", "importJobId", "importJobType", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedTime", "status", "uploadId" ], "members":{ "createdTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the import job was created.
" }, "externalSourceConfiguration":{ "shape":"ExternalSourceConfiguration", "documentation":"The configuration information of the external source that the resource data are imported from.
" }, "importJobId":{ "shape":"Uuid", "documentation":"The identifier of the import job.
" }, "importJobType":{ "shape":"ImportJobType", "documentation":"The type of import job.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the import job was last modified.
" }, "metadata":{ "shape":"ContentMetadata", "documentation":"The metadata fields of the imported Amazon Q in Connect resources.
" }, "status":{ "shape":"ImportJobStatus", "documentation":"The status of the import job.
" }, "uploadId":{ "shape":"UploadId", "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } }, "documentation":"Summary information about the import job.
" }, "ImportJobType":{ "type":"string", "enum":["QUICK_RESPONSES"] }, "Integer":{ "type":"integer", "box":true }, "IntentDetectedDataDetails":{ "type":"structure", "required":[ "intent", "intentId" ], "members":{ "intent":{ "shape":"SensitiveString", "documentation":"The detected intent.
" }, "intentId":{ "shape":"Uuid", "documentation":"The identifier of the detected intent.
" } }, "documentation":"Details about the detected intent.
" }, "IntentInputData":{ "type":"structure", "required":["intentId"], "members":{ "intentId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q intent.
" } }, "documentation":"Information about the Amazon Q intent.
" }, "KnowledgeBaseAssociationConfigurationData":{ "type":"structure", "members":{ "contentTagFilter":{"shape":"TagFilter"}, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
" }, "overrideKnowledgeBaseSearchType":{ "shape":"KnowledgeBaseSearchType", "documentation":"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 data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" } }, "documentation":"Association information about the knowledge base.
" }, "KnowledgeBaseData":{ "type":"structure", "required":[ "knowledgeBaseArn", "knowledgeBaseId", "knowledgeBaseType", "name", "status" ], "members":{ "description":{ "shape":"Description", "documentation":"The description.
" }, "ingestionFailureReasons":{ "shape":"FailureReason", "documentation":"List of failure reasons on ingestion per file.
" }, "ingestionStatus":{ "shape":"SyncStatus", "documentation":"Status of ingestion on data source.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "knowledgeBaseType":{ "shape":"KnowledgeBaseType", "documentation":"The type of knowledge base.
" }, "lastContentModificationTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"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.
" }, "name":{ "shape":"Name", "documentation":"The name of the knowledge base.
" }, "renderingConfiguration":{ "shape":"RenderingConfiguration", "documentation":"Information about how to render the content.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "sourceConfiguration":{ "shape":"SourceConfiguration", "documentation":"Source configuration information about the knowledge base.
" }, "status":{ "shape":"KnowledgeBaseStatus", "documentation":"The status of the knowledge base.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "vectorIngestionConfiguration":{ "shape":"VectorIngestionConfiguration", "documentation":"Contains details about how to ingest the documents in a data source.
" } }, "documentation":"Information about the knowledge base.
" }, "KnowledgeBaseList":{ "type":"list", "member":{"shape":"KnowledgeBaseSummary"} }, "KnowledgeBaseSearchType":{ "type":"string", "enum":[ "HYBRID", "SEMANTIC" ] }, "KnowledgeBaseStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED" ] }, "KnowledgeBaseSummary":{ "type":"structure", "required":[ "knowledgeBaseArn", "knowledgeBaseId", "knowledgeBaseType", "name", "status" ], "members":{ "description":{ "shape":"Description", "documentation":"The description of the knowledge base.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "knowledgeBaseType":{ "shape":"KnowledgeBaseType", "documentation":"The type of knowledge base.
" }, "name":{ "shape":"Name", "documentation":"The name of the knowledge base.
" }, "renderingConfiguration":{ "shape":"RenderingConfiguration", "documentation":"Information about how to render the content.
" }, "serverSideEncryptionConfiguration":{ "shape":"ServerSideEncryptionConfiguration", "documentation":"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.
" }, "sourceConfiguration":{ "shape":"SourceConfiguration", "documentation":"Configuration information about the external data source.
" }, "status":{ "shape":"KnowledgeBaseStatus", "documentation":"The status of the knowledge base summary.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "vectorIngestionConfiguration":{ "shape":"VectorIngestionConfiguration", "documentation":"Contains details about how to ingest the documents in a data source.
" } }, "documentation":"Summary information about the knowledge base.
" }, "KnowledgeBaseType":{ "type":"string", "enum":[ "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED" ] }, "LanguageCode":{ "type":"string", "max":5, "min":2 }, "ListAIAgentVersionsRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "origin":{ "shape":"Origin", "documentation":"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 summaries of AI Agent versions.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "origin":{ "shape":"Origin", "documentation":"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 summaries of AI Agents.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":[ "aiGuardrailId", "assistantId" ], "members":{ "aiGuardrailId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListAIGuardrailVersionsResponse":{ "type":"structure", "required":["aiGuardrailVersionSummaries"], "members":{ "aiGuardrailVersionSummaries":{ "shape":"AIGuardrailVersionSummariesList", "documentation":"The summaries of the AI Guardrail versions.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListAIGuardrailsResponse":{ "type":"structure", "required":["aiGuardrailSummaries"], "members":{ "aiGuardrailSummaries":{ "shape":"AIGuardrailSummariesList", "documentation":"The summaries of the AI Guardrails.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":[ "aiPromptId", "assistantId" ], "members":{ "aiPromptId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "origin":{ "shape":"Origin", "documentation":"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 summaries of the AI Prompt versions.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "origin":{ "shape":"Origin", "documentation":"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 summaries of the AI Prompts.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListAssistantAssociationsResponse":{ "type":"structure", "required":["assistantAssociationSummaries"], "members":{ "assistantAssociationSummaries":{ "shape":"AssistantAssociationSummaryList", "documentation":"Summary information about assistant associations.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListAssistantsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListAssistantsResponse":{ "type":"structure", "required":["assistantSummaries"], "members":{ "assistantSummaries":{ "shape":"AssistantList", "documentation":"Information about the assistants.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListContentAssociationsRequest":{ "type":"structure", "required":[ "contentId", "knowledgeBaseId" ], "members":{ "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListContentAssociationsResponse":{ "type":"structure", "required":["contentAssociationSummaries"], "members":{ "contentAssociationSummaries":{ "shape":"ContentAssociationSummaryList", "documentation":"Summary information about content associations.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListContentsRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListContentsResponse":{ "type":"structure", "required":["contentSummaries"], "members":{ "contentSummaries":{ "shape":"ContentSummaryList", "documentation":"Information about the content.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListImportJobsRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListImportJobsResponse":{ "type":"structure", "required":["importJobSummaries"], "members":{ "importJobSummaries":{ "shape":"ImportJobList", "documentation":"Summary information about the import jobs.
" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"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":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListKnowledgeBasesResponse":{ "type":"structure", "required":["knowledgeBaseSummaries"], "members":{ "knowledgeBaseSummaries":{ "shape":"KnowledgeBaseList", "documentation":"Information about the knowledge bases.
" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListMessageTemplateVersionsRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListMessageTemplateVersionsResponse":{ "type":"structure", "required":["messageTemplateVersionSummaries"], "members":{ "messageTemplateVersionSummaries":{ "shape":"MessageTemplateVersionSummaryList", "documentation":"Summary information about the versions of a message template.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListMessageTemplatesRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListMessageTemplatesResponse":{ "type":"structure", "required":["messageTemplateSummaries"], "members":{ "messageTemplateSummaries":{ "shape":"MessageTemplateSummaryList", "documentation":"Summary information about the message template.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "ListMessagesRequest":{ "type":"structure", "required":[ "assistantId", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect session.
", "location":"uri", "locationName":"sessionId" } } }, "ListMessagesResponse":{ "type":"structure", "required":["messages"], "members":{ "messages":{ "shape":"MessageList", "documentation":"The message information.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListQuickResponsesRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" } } }, "ListQuickResponsesResponse":{ "type":"structure", "required":["quickResponseSummaries"], "members":{ "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
" }, "quickResponseSummaries":{ "shape":"QuickResponseSummaryList", "documentation":"Summary information about the quick responses.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "LlmModelId":{ "type":"string", "max":128, "min":1 }, "ManagedSourceConfiguration":{ "type":"structure", "members":{ "webCrawlerConfiguration":{ "shape":"WebCrawlerConfiguration", "documentation":"Configuration data for web crawler data source.
" } }, "documentation":"Source configuration for managed resources.
", "union":true }, "ManualSearchAIAgentConfiguration":{ "type":"structure", "members":{ "answerGenerationAIGuardrailId":{ "shape":"UuidWithQualifier", "documentation":"The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
" }, "answerGenerationAIPromptId":{ "shape":"UuidWithQualifier", "documentation":"The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
" }, "associationConfigurations":{ "shape":"AssociationConfigurationList", "documentation":"The association configurations for overriding behavior on this AI Agent.
" }, "locale":{ "shape":"NonEmptyString", "documentation":"The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
" } }, "documentation":"The configuration for the MANUAL_SEARCH AI Agent type.
The message data in text type.
" } }, "documentation":"The message data.
", "union":true }, "MessageInput":{ "type":"structure", "required":["value"], "members":{ "value":{ "shape":"MessageData", "documentation":"The message input value.
" } }, "documentation":"The message input.
" }, "MessageList":{ "type":"list", "member":{"shape":"MessageOutput"} }, "MessageOutput":{ "type":"structure", "required":[ "messageId", "participant", "timestamp", "value" ], "members":{ "messageId":{ "shape":"Uuid", "documentation":"The identifier of a message.
" }, "participant":{ "shape":"Participant", "documentation":"The participant of a message.
" }, "timestamp":{ "shape":"Timestamp", "documentation":"The timestamp of a message.
" }, "value":{ "shape":"MessageData", "documentation":"The value of a message data.
" } }, "documentation":"The message output.
" }, "MessageTemplateAttachment":{ "type":"structure", "required":[ "attachmentId", "contentDisposition", "name", "uploadedTime", "url", "urlExpiry" ], "members":{ "attachmentId":{ "shape":"Uuid", "documentation":"The identifier of the attachment file.
" }, "contentDisposition":{ "shape":"ContentDisposition", "documentation":"The presentation information for the attachment file.
" }, "name":{ "shape":"AttachmentFileName", "documentation":"The name of the attachment file being uploaded. The name should include the file extension.
" }, "uploadedTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the attachment file was uploaded.
" }, "url":{ "shape":"Url", "documentation":"A pre-signed Amazon S3 URL that can be used to download the attachment file.
" }, "urlExpiry":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The expiration time of the pre-signed Amazon S3 URL.
" } }, "documentation":"Information about the message template attachment.
" }, "MessageTemplateAttachmentList":{ "type":"list", "member":{"shape":"MessageTemplateAttachment"} }, "MessageTemplateAttributeKey":{ "type":"string", "max":32767, "min":1 }, "MessageTemplateAttributeKeyList":{ "type":"list", "member":{"shape":"MessageTemplateAttributeKey"}, "sensitive":true }, "MessageTemplateAttributeType":{ "type":"string", "enum":[ "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM" ] }, "MessageTemplateAttributeTypeList":{ "type":"list", "member":{"shape":"MessageTemplateAttributeType"} }, "MessageTemplateAttributeValue":{ "type":"string", "max":32767, "min":1, "sensitive":true }, "MessageTemplateAttributes":{ "type":"structure", "members":{ "agentAttributes":{ "shape":"AgentAttributes", "documentation":"The agent attributes that are used with the message template.
" }, "customAttributes":{ "shape":"CustomAttributes", "documentation":"The custom attributes that are used with the message template.
" }, "customerProfileAttributes":{ "shape":"CustomerProfileAttributes", "documentation":"The customer profile attributes that are used with the message template.
" }, "systemAttributes":{ "shape":"SystemAttributes", "documentation":"The system attributes that are used with the message template.
" } }, "documentation":"The attributes that are used with the message template.
" }, "MessageTemplateBodyContentProvider":{ "type":"structure", "members":{ "content":{ "shape":"NonEmptyUnlimitedString", "documentation":"The content of the message template.
" } }, "documentation":"The container of the message template body.
", "union":true }, "MessageTemplateContentProvider":{ "type":"structure", "members":{ "email":{ "shape":"EmailMessageTemplateContent", "documentation":"The content of the message template that applies to the email channel subtype.
" }, "sms":{ "shape":"SMSMessageTemplateContent", "documentation":"The content of the message template that applies to the SMS channel subtype.
" } }, "documentation":"The container of message template content.
", "union":true }, "MessageTemplateContentSha256":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9]+$" }, "MessageTemplateData":{ "type":"structure", "required":[ "channelSubtype", "content", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedBy", "lastModifiedTime", "messageTemplateArn", "messageTemplateContentSha256", "messageTemplateId", "name" ], "members":{ "attributeTypes":{ "shape":"MessageTemplateAttributeTypeList", "documentation":"The types of attributes that the message template contains.
" }, "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "content":{ "shape":"MessageTemplateContentProvider", "documentation":"The content of the message template.
" }, "createdTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template was created.
" }, "defaultAttributes":{ "shape":"MessageTemplateAttributes", "documentation":"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.
" }, "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "groupingConfiguration":{"shape":"GroupingConfiguration"}, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "language":{ "shape":"LanguageCode", "documentation":"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 Amazon Resource Name (ARN) of the user who last updated the message template data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template data was last modified.
" }, "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateContentSha256":{ "shape":"MessageTemplateContentSha256", "documentation":"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 identifier of the message template.
" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"The data of a message template.
" }, "MessageTemplateFilterField":{ "type":"structure", "required":[ "name", "operator" ], "members":{ "includeNoExistence":{ "shape":"Boolean", "documentation":"Whether to treat null value as a match for the attribute field.
" }, "name":{ "shape":"NonEmptyString", "documentation":"The name of the attribute field to filter the message templates by.
" }, "operator":{ "shape":"MessageTemplateFilterOperator", "documentation":"The operator to use for filtering.
" }, "values":{ "shape":"MessageTemplateFilterValueList", "documentation":"The values of attribute field to filter the message template by.
" } }, "documentation":"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 name of the message template.
" }, "order":{ "shape":"Order", "documentation":"The order at which the message templates are sorted by.
" } }, "documentation":"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
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.
" }, "name":{ "shape":"NonEmptyString", "documentation":"The name of the attribute to query the message templates by.
" }, "operator":{ "shape":"MessageTemplateQueryOperator", "documentation":"The operator to use for matching attribute field values in the query.
" }, "priority":{ "shape":"Priority", "documentation":"The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
" }, "values":{ "shape":"MessageTemplateQueryValueList", "documentation":"The values of the attribute to query the message templates by.
" } }, "documentation":"The message template fields to query message templates by. The following is the list of supported field names:
name
description
The configuration of filtering rules applied to message template query results.
" }, "orderOnField":{ "shape":"MessageTemplateOrderField", "documentation":"The message template attribute fields on which the query results are ordered.
" }, "queries":{ "shape":"MessageTemplateQueryFieldList", "documentation":"The message template query expressions.
" } }, "documentation":"The search expression of the message template.
" }, "MessageTemplateSearchResultData":{ "type":"structure", "required":[ "channelSubtype", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedBy", "lastModifiedTime", "messageTemplateArn", "messageTemplateId", "name" ], "members":{ "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "createdTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "groupingConfiguration":{"shape":"GroupingConfiguration"}, "isActive":{ "shape":"Boolean", "documentation":"Whether the version of the message template is activated.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "language":{ "shape":"LanguageCode", "documentation":"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 Amazon Resource Name (ARN) of the user who last updated the message template data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template data was last modified.
" }, "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateId":{ "shape":"Uuid", "documentation":"The identifier of the message template.
" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version.
" } }, "documentation":"The result of message template search.
" }, "MessageTemplateSearchResultsList":{ "type":"list", "member":{"shape":"MessageTemplateSearchResultData"} }, "MessageTemplateSummary":{ "type":"structure", "required":[ "channelSubtype", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedBy", "lastModifiedTime", "messageTemplateArn", "messageTemplateId", "name" ], "members":{ "activeVersionNumber":{ "shape":"Version", "documentation":"The version number of the message template version that is activated.
" }, "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "createdTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template was created.
" }, "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "lastModifiedBy":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of the user who last updated the message template data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The timestamp when the message template data was last modified.
" }, "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateId":{ "shape":"Uuid", "documentation":"The identifier of the message template.
" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"The summary of the message template.
" }, "MessageTemplateSummaryList":{ "type":"list", "member":{"shape":"MessageTemplateSummary"} }, "MessageTemplateVersionSummary":{ "type":"structure", "required":[ "channelSubtype", "isActive", "knowledgeBaseArn", "knowledgeBaseId", "messageTemplateArn", "messageTemplateId", "name", "versionNumber" ], "members":{ "channelSubtype":{ "shape":"ChannelSubtype", "documentation":"The channel subtype this message template applies to.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the version of the message template is activated.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "messageTemplateArn":{ "shape":"ArnWithQualifier", "documentation":"The Amazon Resource Name (ARN) of the message template.
" }, "messageTemplateId":{ "shape":"Uuid", "documentation":"The identifier of the message template.
" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" }, "versionNumber":{ "shape":"Version", "documentation":"The version number of the message template version.
" } }, "documentation":"The summary of the message template version.
" }, "MessageTemplateVersionSummaryList":{ "type":"list", "member":{"shape":"MessageTemplateVersionSummary"} }, "MessageType":{ "type":"string", "enum":["TEXT"] }, "Name":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9\\s_.,-]+" }, "NextToken":{ "type":"string", "max":2048, "min":1 }, "NonEmptySensitiveString":{ "type":"string", "max":4096, "min":1, "sensitive":true }, "NonEmptyString":{ "type":"string", "max":4096, "min":1 }, "NonEmptyUnlimitedString":{ "type":"string", "min":1, "sensitive":true }, "NotifyRecommendationsReceivedError":{ "type":"structure", "members":{ "message":{ "shape":"NotifyRecommendationsReceivedErrorMessage", "documentation":"A recommendation is causing an error.
" }, "recommendationId":{ "shape":"RecommendationId", "documentation":"The identifier of the recommendation that is in error.
" } }, "documentation":"An error occurred when creating a recommendation.
" }, "NotifyRecommendationsReceivedErrorList":{ "type":"list", "member":{"shape":"NotifyRecommendationsReceivedError"} }, "NotifyRecommendationsReceivedErrorMessage":{"type":"string"}, "NotifyRecommendationsReceivedRequest":{ "type":"structure", "required":[ "assistantId", "recommendationIds", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "recommendationIds":{ "shape":"RecommendationIdList", "documentation":"The identifiers of the recommendations.
" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"sessionId" } } }, "NotifyRecommendationsReceivedResponse":{ "type":"structure", "members":{ "errors":{ "shape":"NotifyRecommendationsReceivedErrorList", "documentation":"The identifiers of recommendations that are causing errors.
" }, "recommendationIds":{ "shape":"RecommendationIdList", "documentation":"The identifiers of the recommendations.
" } } }, "ObjectFieldsList":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":100, "min":1 }, "OrCondition":{ "type":"structure", "members":{ "andConditions":{ "shape":"AndConditions", "documentation":"A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition.
" } }, "documentation":"A list of conditions which would be applied together with an OR condition.
Settings for a foundation model used to parse documents for a data source.
" }, "parsingStrategy":{ "shape":"ParsingStrategy", "documentation":"The parsing strategy for the data source.
" } }, "documentation":"Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
" }, "ParsingPrompt":{ "type":"structure", "required":["parsingPromptText"], "members":{ "parsingPromptText":{ "shape":"ParsingPromptText", "documentation":"Instructions for interpreting the contents of a document.
" } }, "documentation":"Instructions for interpreting the contents of a document.
" }, "ParsingPromptText":{ "type":"string", "max":10000, "min":1 }, "ParsingStrategy":{ "type":"string", "enum":["BEDROCK_FOUNDATION_MODEL"] }, "Participant":{ "type":"string", "enum":[ "CUSTOMER", "AGENT", "BOT" ] }, "PreconditionFailedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The provided revisionId does not match, indicating the content has been modified since it was last read.
The identifier of the Amazon Q in Connect assistant.
", "location":"uri", "locationName":"assistantId" }, "contentFeedback":{ "shape":"ContentFeedbackData", "documentation":"Information about the feedback provided.
" }, "targetId":{ "shape":"Uuid", "documentation":"The identifier of the feedback target.
" }, "targetType":{ "shape":"TargetType", "documentation":"The type of the feedback target.
" } } }, "PutFeedbackResponse":{ "type":"structure", "required":[ "assistantArn", "assistantId", "contentFeedback", "targetId", "targetType" ], "members":{ "assistantArn":{ "shape":"UuidOrArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "contentFeedback":{ "shape":"ContentFeedbackData", "documentation":"Information about the feedback provided.
" }, "targetId":{ "shape":"Uuid", "documentation":"The identifier of the feedback target.
" }, "targetType":{ "shape":"TargetType", "documentation":"The type of the feedback target.
" } } }, "QueryAssistantRequest":{ "type":"structure", "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
" }, "overrideKnowledgeBaseSearchType":{ "shape":"KnowledgeBaseSearchType", "documentation":"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.
Information about how to query content.
" }, "queryInputData":{ "shape":"QueryInputData", "documentation":"Information about the query.
" }, "queryText":{ "shape":"QueryText", "documentation":"The text to search for.
" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
" } } }, "QueryAssistantResponse":{ "type":"structure", "required":["results"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" }, "results":{ "shape":"QueryResultsList", "documentation":"The results of the query.
" } } }, "QueryCondition":{ "type":"structure", "members":{ "single":{ "shape":"QueryConditionItem", "documentation":"The condition for the query.
" } }, "documentation":"Information about how to query content.
", "union":true }, "QueryConditionComparisonOperator":{ "type":"string", "enum":["EQUALS"] }, "QueryConditionExpression":{ "type":"list", "member":{"shape":"QueryCondition"}, "max":1, "min":0 }, "QueryConditionFieldName":{ "type":"string", "enum":["RESULT_TYPE"] }, "QueryConditionItem":{ "type":"structure", "required":[ "comparator", "field", "value" ], "members":{ "comparator":{ "shape":"QueryConditionComparisonOperator", "documentation":"The comparison operator for query condition to query on.
" }, "field":{ "shape":"QueryConditionFieldName", "documentation":"The name of the field for query condition to query on.
" }, "value":{ "shape":"NonEmptyString", "documentation":"The value for the query condition to query on.
" } }, "documentation":"The condition for the query.
" }, "QueryInputData":{ "type":"structure", "members":{ "intentInputData":{ "shape":"IntentInputData", "documentation":"Input information for the intent.
" }, "queryTextInputData":{ "shape":"QueryTextInputData", "documentation":"Input information for the query.
" } }, "documentation":"Input information for the query.
", "union":true }, "QueryRecommendationTriggerData":{ "type":"structure", "members":{ "text":{ "shape":"QueryText", "documentation":"The text associated with the recommendation trigger.
" } }, "documentation":"Data associated with the QUERY RecommendationTriggerType.
" }, "QueryResultType":{ "type":"string", "enum":[ "KNOWLEDGE_CONTENT", "INTENT_ANSWER", "GENERATIVE_ANSWER" ] }, "QueryResultsList":{ "type":"list", "member":{"shape":"ResultData"} }, "QueryText":{ "type":"string", "max":512, "min":0, "sensitive":true }, "QueryTextInputData":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"QueryText", "documentation":"The text to search for.
" } }, "documentation":"Information about the text to search for.
" }, "QuickResponseContent":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "QuickResponseContentProvider":{ "type":"structure", "members":{ "content":{ "shape":"QuickResponseContent", "documentation":"The content of the quick response.
" } }, "documentation":"The container quick response content.
", "union":true }, "QuickResponseContents":{ "type":"structure", "members":{ "markdown":{"shape":"QuickResponseContentProvider"}, "plainText":{"shape":"QuickResponseContentProvider"} }, "documentation":"The content of the quick response stored in different media types.
" }, "QuickResponseData":{ "type":"structure", "required":[ "contentType", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedTime", "name", "quickResponseArn", "quickResponseId", "status" ], "members":{ "channels":{ "shape":"Channels", "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
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 contents of the quick response.
" }, "createdTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the quick response was created.
" }, "description":{ "shape":"QuickResponseDescription", "documentation":"The description of the quick response.
" }, "groupingConfiguration":{ "shape":"GroupingConfiguration", "documentation":"The configuration information of the user groups that the quick response is accessible to.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the quick response is active.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "language":{ "shape":"LanguageCode", "documentation":"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 Amazon Resource Name (ARN) of the user who last updated the quick response data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the quick response data was last modified.
" }, "name":{ "shape":"QuickResponseName", "documentation":"The name of the quick response.
" }, "quickResponseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the quick response.
" }, "quickResponseId":{ "shape":"Uuid", "documentation":"The identifier of the quick response.
" }, "shortcutKey":{ "shape":"ShortCutKey", "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" }, "status":{ "shape":"QuickResponseStatus", "documentation":"The status of the quick response data.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Information about the quick response.
" }, "QuickResponseDataProvider":{ "type":"structure", "members":{ "content":{ "shape":"QuickResponseContent", "documentation":"The content of the quick response.
" } }, "documentation":"The container of quick response data.
", "union":true }, "QuickResponseDescription":{ "type":"string", "max":255, "min":1 }, "QuickResponseFilterField":{ "type":"structure", "required":[ "name", "operator" ], "members":{ "includeNoExistence":{ "shape":"Boolean", "documentation":"Whether to treat null value as a match for the attribute field.
" }, "name":{ "shape":"NonEmptyString", "documentation":"The name of the attribute field to filter the quick responses by.
" }, "operator":{ "shape":"QuickResponseFilterOperator", "documentation":"The operator to use for filtering.
" }, "values":{ "shape":"QuickResponseFilterValueList", "documentation":"The values of attribute field to filter the quick response by.
" } }, "documentation":"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 name of the attribute to order the quick response query results by.
" }, "order":{ "shape":"Order", "documentation":"The order at which the quick responses are sorted by.
" } }, "documentation":"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
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.
" }, "name":{ "shape":"NonEmptyString", "documentation":"The name of the attribute to query the quick responses by.
" }, "operator":{ "shape":"QuickResponseQueryOperator", "documentation":"The operator to use for matching attribute field values in the query.
" }, "priority":{ "shape":"Priority", "documentation":"The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
" }, "values":{ "shape":"QuickResponseQueryValueList", "documentation":"The values of the attribute to query the quick responses by.
" } }, "documentation":"The quick response fields to query quick responses by.
The following is the list of supported field names.
content
name
description
shortcutKey
The configuration of filtering rules applied to quick response query results.
" }, "orderOnField":{ "shape":"QuickResponseOrderField", "documentation":"The quick response attribute fields on which the query results are ordered.
" }, "queries":{ "shape":"QuickResponseQueryFieldList", "documentation":"The quick response query expressions.
" } }, "documentation":"Information about the import job.
" }, "QuickResponseSearchResultData":{ "type":"structure", "required":[ "contentType", "contents", "createdTime", "isActive", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedTime", "name", "quickResponseArn", "quickResponseId", "status" ], "members":{ "attributesInterpolated":{ "shape":"ContactAttributeKeys", "documentation":"The user defined contact attributes that are resolved when the search result is returned.
" }, "attributesNotInterpolated":{ "shape":"ContactAttributeKeys", "documentation":"The user defined contact attributes that are not resolved when the search result is returned.
" }, "channels":{ "shape":"Channels", "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
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 contents of the quick response.
" }, "createdTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the quick response was created.
" }, "description":{ "shape":"QuickResponseDescription", "documentation":"The description of the quick response.
" }, "groupingConfiguration":{ "shape":"GroupingConfiguration", "documentation":"The configuration information of the user groups that the quick response is accessible to.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the quick response is active.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
" }, "language":{ "shape":"LanguageCode", "documentation":"The language code value for the language in which the quick response is written.
" }, "lastModifiedBy":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the quick response search result data was last modified.
" }, "name":{ "shape":"QuickResponseName", "documentation":"The name of the quick response.
" }, "quickResponseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the quick response.
" }, "quickResponseId":{ "shape":"Uuid", "documentation":"The identifier of the quick response.
" }, "shortcutKey":{ "shape":"ShortCutKey", "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" }, "status":{ "shape":"QuickResponseStatus", "documentation":"The resource status of the quick response.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"The result of quick response search.
" }, "QuickResponseSearchResultsList":{ "type":"list", "member":{"shape":"QuickResponseSearchResultData"} }, "QuickResponseStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED" ] }, "QuickResponseSummary":{ "type":"structure", "required":[ "contentType", "createdTime", "knowledgeBaseArn", "knowledgeBaseId", "lastModifiedTime", "name", "quickResponseArn", "quickResponseId", "status" ], "members":{ "channels":{ "shape":"Channels", "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
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 timestamp when the quick response was created.
" }, "description":{ "shape":"QuickResponseDescription", "documentation":"The description of the quick response.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the quick response is active.
" }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" }, "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base.
" }, "lastModifiedBy":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" }, "lastModifiedTime":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The timestamp when the quick response summary was last modified.
" }, "name":{ "shape":"QuickResponseName", "documentation":"The name of the quick response.
" }, "quickResponseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the quick response.
" }, "quickResponseId":{ "shape":"Uuid", "documentation":"The identifier of the quick response.
" }, "status":{ "shape":"QuickResponseStatus", "documentation":"The resource status of the quick response.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"The summary information about the quick response.
" }, "QuickResponseSummaryList":{ "type":"list", "member":{"shape":"QuickResponseSummary"} }, "QuickResponseType":{ "type":"string", "pattern":"^(application/x\\.quickresponse;format=(plain|markdown))$" }, "RankingData":{ "type":"structure", "members":{ "relevanceLevel":{ "shape":"RelevanceLevel", "documentation":"The relevance score of the content.
" }, "relevanceScore":{ "shape":"RelevanceScore", "documentation":"The relevance level of the recommendation.
" } }, "documentation":"Details about the source content ranking data.
" }, "RecommendationData":{ "type":"structure", "required":["recommendationId"], "members":{ "data":{ "shape":"DataSummary", "documentation":"Summary of the recommended content.
" }, "document":{ "shape":"Document", "documentation":"The recommended document.
" }, "recommendationId":{ "shape":"RecommendationId", "documentation":"The identifier of the recommendation.
" }, "relevanceLevel":{ "shape":"RelevanceLevel", "documentation":"The relevance level of the recommendation.
" }, "relevanceScore":{ "shape":"RelevanceScore", "documentation":"The relevance score of the recommendation.
" }, "type":{ "shape":"RecommendationType", "documentation":"The type of recommendation.
" } }, "documentation":"Information about the recommendation.
" }, "RecommendationId":{ "type":"string", "max":2048, "min":1 }, "RecommendationIdList":{ "type":"list", "member":{"shape":"RecommendationId"}, "max":25, "min":0 }, "RecommendationList":{ "type":"list", "member":{"shape":"RecommendationData"} }, "RecommendationSourceType":{ "type":"string", "enum":[ "ISSUE_DETECTION", "RULE_EVALUATION", "OTHER" ] }, "RecommendationTrigger":{ "type":"structure", "required":[ "data", "id", "recommendationIds", "source", "type" ], "members":{ "data":{ "shape":"RecommendationTriggerData", "documentation":"A union type containing information related to the trigger.
" }, "id":{ "shape":"Uuid", "documentation":"The identifier of the recommendation trigger.
" }, "recommendationIds":{ "shape":"RecommendationIdList", "documentation":"The identifiers of the recommendations.
" }, "source":{ "shape":"RecommendationSourceType", "documentation":"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.
The type of recommendation trigger.
" } }, "documentation":"A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.
Data associated with the QUERY RecommendationTriggerType.
" } }, "documentation":"A union type containing information related to the trigger.
", "union":true }, "RecommendationTriggerList":{ "type":"list", "member":{"shape":"RecommendationTrigger"} }, "RecommendationTriggerType":{ "type":"string", "enum":[ "QUERY", "GENERATIVE" ] }, "RecommendationType":{ "type":"string", "enum":[ "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", "GENERATIVE_ANSWER", "DETECTED_INTENT" ] }, "ReferenceType":{ "type":"string", "enum":[ "WEB_CRAWLER", "KNOWLEDGE_BASE" ] }, "Relevance":{ "type":"string", "enum":[ "HELPFUL", "NOT_HELPFUL" ] }, "RelevanceLevel":{ "type":"string", "enum":[ "HIGH", "MEDIUM", "LOW" ] }, "RelevanceScore":{ "type":"double", "min":0.0 }, "RemoveAssistantAIAgentRequest":{ "type":"structure", "required":[ "aiAgentType", "assistantId" ], "members":{ "aiAgentType":{ "shape":"AIAgentType", "documentation":"The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.
", "location":"querystring", "locationName":"aiAgentType" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" } } }, "RemoveAssistantAIAgentResponse":{ "type":"structure", "members":{ } }, "RemoveKnowledgeBaseTemplateUriRequest":{ "type":"structure", "required":["knowledgeBaseId"], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" } } }, "RemoveKnowledgeBaseTemplateUriResponse":{ "type":"structure", "members":{ } }, "RenderMessageTemplateRequest":{ "type":"structure", "required":[ "attributes", "knowledgeBaseId", "messageTemplateId" ], "members":{ "attributes":{ "shape":"MessageTemplateAttributes", "documentation":"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.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN.
", "location":"uri", "locationName":"messageTemplateId" } } }, "RenderMessageTemplateResponse":{ "type":"structure", "required":["content"], "members":{ "attachments":{ "shape":"MessageTemplateAttachmentList", "documentation":"The message template attachments.
" }, "attributesNotInterpolated":{ "shape":"MessageTemplateAttributeKeyList", "documentation":"The attribute keys that are not resolved.
" }, "content":{ "shape":"MessageTemplateContentProvider", "documentation":"The content of the message template.
" } } }, "RenderingConfiguration":{ "type":"structure", "members":{ "templateUri":{ "shape":"Uri", "documentation":"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.
" } }, "documentation":"Information about how to render the content.
" }, "RequestTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"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.
", "error":{ "httpStatusCode":408, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "resourceName":{ "shape":"String", "documentation":"The specified resource name.
" } }, "documentation":"The specified resource does not exist.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResultData":{ "type":"structure", "required":["resultId"], "members":{ "data":{ "shape":"DataSummary", "documentation":"Summary of the recommended content.
" }, "document":{ "shape":"Document", "documentation":"The document.
" }, "relevanceScore":{ "shape":"RelevanceScore", "documentation":"The relevance score of the results.
" }, "resultId":{ "shape":"Uuid", "documentation":"The identifier of the result data.
" }, "type":{ "shape":"QueryResultType", "documentation":"The type of the query result.
" } }, "documentation":"Information about the result.
" }, "RuntimeSessionData":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"NonEmptySensitiveString", "documentation":"The key of the data stored on the session.
" }, "value":{ "shape":"RuntimeSessionDataValue", "documentation":"The value of the data stored on the session.
" } }, "documentation":"The list of key-value pairs that are stored on the session.
" }, "RuntimeSessionDataList":{ "type":"list", "member":{"shape":"RuntimeSessionData"}, "max":50, "min":0 }, "RuntimeSessionDataValue":{ "type":"structure", "members":{ "stringValue":{ "shape":"NonEmptySensitiveString", "documentation":"The string value of the data stored on the session.
" } }, "documentation":"A union type that specifies the data stored on the session.
", "union":true }, "SMSMessageTemplateContent":{ "type":"structure", "members":{ "body":{ "shape":"SMSMessageTemplateContentBody", "documentation":"The body to use in SMS messages.
" } }, "documentation":"The content of the message template that applies to the SMS channel subtype.
" }, "SMSMessageTemplateContentBody":{ "type":"structure", "members":{ "plainText":{ "shape":"MessageTemplateBodyContentProvider", "documentation":"The message body to use in SMS messages.
" } }, "documentation":"The body to use in SMS messages.
" }, "SearchContentRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "searchExpression" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "searchExpression":{ "shape":"SearchExpression", "documentation":"The search expression to filter results.
" } } }, "SearchContentResponse":{ "type":"structure", "required":["contentSummaries"], "members":{ "contentSummaries":{ "shape":"ContentSummaryList", "documentation":"Summary information about the content.
" }, "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" } } }, "SearchExpression":{ "type":"structure", "required":["filters"], "members":{ "filters":{ "shape":"FilterList", "documentation":"The search expression filters.
" } }, "documentation":"The search expression.
" }, "SearchMessageTemplatesRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "searchExpression" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "searchExpression":{ "shape":"MessageTemplateSearchExpression", "documentation":"The search expression for querying the message template.
" } } }, "SearchMessageTemplatesResponse":{ "type":"structure", "required":["results"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" }, "results":{ "shape":"MessageTemplateSearchResultsList", "documentation":"The results of the message template search.
" } } }, "SearchQuickResponsesRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "searchExpression" ], "members":{ "attributes":{ "shape":"ContactAttributes", "documentation":"The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "searchExpression":{ "shape":"QuickResponseSearchExpression", "documentation":"The search expression for querying the quick response.
" } } }, "SearchQuickResponsesResponse":{ "type":"structure", "required":["results"], "members":{ "nextToken":{ "shape":"NonEmptyString", "documentation":"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.
" }, "results":{ "shape":"QuickResponseSearchResultsList", "documentation":"The results of the quick response search.
" } } }, "SearchSessionsRequest":{ "type":"structure", "required":[ "assistantId", "searchExpression" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page.
", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "searchExpression":{ "shape":"SearchExpression", "documentation":"The search expression to filter results.
" } } }, "SearchSessionsResponse":{ "type":"structure", "required":["sessionSummaries"], "members":{ "nextToken":{ "shape":"NextToken", "documentation":"If there are additional results, this is the token for the next set of results.
" }, "sessionSummaries":{ "shape":"SessionSummaries", "documentation":"Summary information about the sessions.
" } } }, "SeedUrl":{ "type":"structure", "members":{ "url":{ "shape":"WebUrl", "documentation":"URL for crawling
" } }, "documentation":"A URL for crawling.
" }, "SeedUrls":{ "type":"list", "member":{"shape":"SeedUrl"}, "max":100, "min":1 }, "SelfServiceAIAgentConfiguration":{ "type":"structure", "members":{ "associationConfigurations":{ "shape":"AssociationConfigurationList", "documentation":"The association configurations for overriding behavior on this AI Agent.
" }, "selfServiceAIGuardrailId":{ "shape":"UuidWithQualifier", "documentation":"The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
" }, "selfServiceAnswerGenerationAIPromptId":{ "shape":"UuidWithQualifier", "documentation":"The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
" }, "selfServicePreProcessingAIPromptId":{ "shape":"UuidWithQualifier", "documentation":"The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
" } }, "documentation":"The configuration for AI Agents of type SELF_SERVICE.
" }, "SelfServiceConversationHistory":{ "type":"structure", "required":["turnNumber"], "members":{ "botResponse":{ "shape":"SensitiveString", "documentation":"The bot response of the conversation history data.
" }, "inputTranscript":{ "shape":"SensitiveString", "documentation":"The input transcript of the conversation history data.
" }, "turnNumber":{ "shape":"Integer", "documentation":"The number of turn of the conversation history data.
" } }, "documentation":"The conversation history data to included in conversation context data before the the Amazon Q in Connect session..
" }, "SelfServiceConversationHistoryList":{ "type":"list", "member":{"shape":"SelfServiceConversationHistory"}, "max":10, "min":0 }, "SemanticChunkingConfiguration":{ "type":"structure", "required":[ "breakpointPercentileThreshold", "bufferSize", "maxTokens" ], "members":{ "breakpointPercentileThreshold":{ "shape":"SemanticChunkingConfigurationBreakpointPercentileThresholdInteger", "documentation":"The dissimilarity threshold for splitting chunks.
" }, "bufferSize":{ "shape":"SemanticChunkingConfigurationBufferSizeInteger", "documentation":"The buffer size.
" }, "maxTokens":{ "shape":"SemanticChunkingConfigurationMaxTokensInteger", "documentation":"The maximum number of tokens that a chunk can contain.
" } }, "documentation":"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":{ "type":"integer", "box":true, "max":99, "min":50 }, "SemanticChunkingConfigurationBufferSizeInteger":{ "type":"integer", "box":true, "max":1, "min":0 }, "SemanticChunkingConfigurationMaxTokensInteger":{ "type":"integer", "box":true, "min":1 }, "SendMessageRequest":{ "type":"structure", "required":[ "assistantId", "message", "sessionId", "type" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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.
", "idempotencyToken":true }, "conversationContext":{ "shape":"ConversationContext", "documentation":"The conversation context before the Amazon Q in Connect session.
" }, "message":{ "shape":"MessageInput", "documentation":"The message data to submit to the Amazon Q in Connect session.
" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect session.
", "location":"uri", "locationName":"sessionId" }, "type":{ "shape":"MessageType", "documentation":"The message type.
" } } }, "SendMessageResponse":{ "type":"structure", "required":[ "nextMessageToken", "requestMessageId" ], "members":{ "nextMessageToken":{ "shape":"NextToken", "documentation":"The token for the next message, used by GetNextMessage.
" }, "requestMessageId":{ "shape":"Uuid", "documentation":"The identifier of the submitted message.
" } } }, "SensitiveString":{ "type":"string", "sensitive":true }, "ServerSideEncryptionConfiguration":{ "type":"structure", "members":{ "kmsKeyId":{ "shape":"NonEmptyString", "documentation":"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).
" } }, "documentation":"The configuration information for the customer managed key used for encryption.
" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"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.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SessionData":{ "type":"structure", "required":[ "name", "sessionArn", "sessionId" ], "members":{ "aiAgentConfiguration":{ "shape":"AIAgentConfigurationMap", "documentation":"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.
" }, "description":{ "shape":"Description", "documentation":"The description of the session.
" }, "integrationConfiguration":{ "shape":"SessionIntegrationConfiguration", "documentation":"The configuration information for the session integration.
" }, "name":{ "shape":"Name", "documentation":"The name of the session.
" }, "sessionArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The identifier of the session.
" }, "tagFilter":{ "shape":"TagFilter", "documentation":"An object that can be used to specify Tag conditions.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } }, "documentation":"Information about the session.
" }, "SessionDataNamespace":{ "type":"string", "enum":["Custom"] }, "SessionIntegrationConfiguration":{ "type":"structure", "members":{ "topicIntegrationArn":{ "shape":"GenericArn", "documentation":"The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } }, "documentation":"The configuration information for the session integration.
" }, "SessionSummaries":{ "type":"list", "member":{"shape":"SessionSummary"} }, "SessionSummary":{ "type":"structure", "required":[ "assistantArn", "assistantId", "sessionArn", "sessionId" ], "members":{ "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" }, "assistantId":{ "shape":"Uuid", "documentation":"The identifier of the Amazon Q in Connect assistant.
" }, "sessionArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The identifier of the session.
" } }, "documentation":"Summary information about the session.
" }, "ShortCutKey":{ "type":"string", "max":10, "min":1 }, "SourceConfiguration":{ "type":"structure", "members":{ "appIntegrations":{ "shape":"AppIntegrationsConfiguration", "documentation":"Configuration information for Amazon AppIntegrations to automatically ingest content.
" }, "managedSourceConfiguration":{ "shape":"ManagedSourceConfiguration", "documentation":"Source configuration for managed resources.
" } }, "documentation":"Configuration information about the external data source.
", "union":true }, "SourceContentDataDetails":{ "type":"structure", "required":[ "id", "rankingData", "textData", "type" ], "members":{ "citationSpan":{ "shape":"CitationSpan", "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" }, "id":{ "shape":"Uuid", "documentation":"The identifier of the source content.
" }, "rankingData":{ "shape":"RankingData", "documentation":"Details about the source content ranking data.
" }, "textData":{ "shape":"TextData", "documentation":"Details about the source content text data.
" }, "type":{ "shape":"SourceContentType", "documentation":"The type of the source content.
" } }, "documentation":"Details about the source content data.
" }, "SourceContentType":{ "type":"string", "enum":["KNOWLEDGE_CONTENT"] }, "StartContentUploadRequest":{ "type":"structure", "required":[ "contentType", "knowledgeBaseId" ], "members":{ "contentType":{ "shape":"ContentType", "documentation":"The type of content to upload.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "presignedUrlTimeToLive":{ "shape":"TimeToLive", "documentation":"The expected expiration time of the generated presigned URL, specified in minutes.
" } } }, "StartContentUploadResponse":{ "type":"structure", "required":[ "headersToInclude", "uploadId", "url", "urlExpiry" ], "members":{ "headersToInclude":{ "shape":"Headers", "documentation":"The headers to include in the upload.
" }, "uploadId":{ "shape":"UploadId", "documentation":"The identifier of the upload.
" }, "url":{ "shape":"Url", "documentation":"The URL of the upload.
" }, "urlExpiry":{ "shape":"SyntheticTimestamp_epoch_seconds", "documentation":"The expiration time of the URL as an epoch timestamp.
" } } }, "StartImportJobRequest":{ "type":"structure", "required":[ "importJobType", "knowledgeBaseId", "uploadId" ], "members":{ "clientToken":{ "shape":"NonEmptyString", "documentation":"The tags used to organize, track, or control access for this resource.
", "idempotencyToken":true }, "externalSourceConfiguration":{ "shape":"ExternalSourceConfiguration", "documentation":"The configuration information of the external source that the resource data are imported from.
" }, "importJobType":{ "shape":"ImportJobType", "documentation":"The type of the import job.
For importing quick response resource, set the value to QUICK_RESPONSES.
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 metadata fields of the imported Amazon Q in Connect resources.
" }, "uploadId":{ "shape":"UploadId", "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } } }, "StartImportJobResponse":{ "type":"structure", "members":{ "importJob":{ "shape":"ImportJobData", "documentation":"The import job.
" } } }, "Status":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED" ] }, "String":{"type":"string"}, "SyncStatus":{ "type":"string", "enum":[ "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS" ] }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "SyntheticTimestamp_epoch_seconds":{ "type":"timestamp", "timestampFormat":"unixTimestamp" }, "SystemAttributes":{ "type":"structure", "members":{ "customerEndpoint":{ "shape":"SystemEndpointAttributes", "documentation":"The CustomerEndpoint attribute.
" }, "name":{ "shape":"MessageTemplateAttributeValue", "documentation":"The name of the task.
" }, "systemEndpoint":{ "shape":"SystemEndpointAttributes", "documentation":"The SystemEndpoint attribute.
" } }, "documentation":"The system attributes that are used with the message template.
" }, "SystemEndpointAttributes":{ "type":"structure", "members":{ "address":{ "shape":"MessageTemplateAttributeValue", "documentation":"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 system endpoint attributes that are used with the message template.
" }, "TagCondition":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"TagKey", "documentation":"The tag key in the tag condition.
" }, "value":{ "shape":"TagValue", "documentation":"The tag value in the tag condition.
" } }, "documentation":"A leaf node condition which can be used to specify a tag condition.
" }, "TagFilter":{ "type":"structure", "members":{ "andConditions":{ "shape":"AndConditions", "documentation":"A list of conditions which would be applied together with an AND condition.
A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a tag condition.
" } }, "documentation":"An object that can be used to specify Tag conditions.
", "union":true }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":1 }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "TargetType":{ "type":"string", "enum":[ "RECOMMENDATION", "RESULT" ] }, "TextAIPrompt":{ "type":"string", "max":200000, "min":1, "sensitive":true }, "TextData":{ "type":"structure", "members":{ "excerpt":{"shape":"DocumentText"}, "title":{"shape":"DocumentText"} }, "documentation":"Details about the source content text data.
" }, "TextFullAIPromptEditTemplateConfiguration":{ "type":"structure", "required":["text"], "members":{ "text":{ "shape":"TextAIPrompt", "documentation":"The YAML text for the AI Prompt template.
" } }, "documentation":"The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
" }, "TextMessage":{ "type":"structure", "members":{ "value":{ "shape":"TextMessageValueString", "documentation":"The value of the message data in text type.
" } }, "documentation":"The message data in text type.
" }, "TextMessageValueString":{ "type":"string", "max":1024, "min":1, "sensitive":true }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The throttling limit has been exceeded.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TimeToLive":{ "type":"integer", "documentation":"Expiration time in minutes
", "box":true, "max":60, "min":1 }, "Timestamp":{"type":"timestamp"}, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "resourceName":{ "shape":"String", "documentation":"The specified resource name.
" } }, "documentation":"Amazon Q in Connect throws this exception if you have too many tags in your tag set.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAIAgentRequest":{ "type":"structure", "required":[ "aiAgentId", "assistantId", "visibilityStatus" ], "members":{ "aiAgentId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Agent.
", "location":"uri", "locationName":"aiAgentId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "configuration":{ "shape":"AIAgentConfiguration", "documentation":"The configuration of the Amazon Q in Connect AI Agent.
" }, "description":{ "shape":"Description", "documentation":"The description of the Amazon Q in Connect AI Agent.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visbility status of the Amazon Q in Connect AI Agent.
" } } }, "UpdateAIAgentResponse":{ "type":"structure", "members":{ "aiAgent":{ "shape":"AIAgentData", "documentation":"The data of the updated Amazon Q in Connect AI Agent.
" } } }, "UpdateAIGuardrailRequest":{ "type":"structure", "required":[ "aiGuardrailId", "assistantId", "blockedInputMessaging", "blockedOutputsMessaging", "visibilityStatus" ], "members":{ "aiGuardrailId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Guardrail.
", "location":"uri", "locationName":"aiGuardrailId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "blockedInputMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a prompt.
" }, "blockedOutputsMessaging":{ "shape":"AIGuardrailBlockedMessaging", "documentation":"The message to return when the AI Guardrail blocks a model response.
" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "contentPolicyConfig":{ "shape":"AIGuardrailContentPolicyConfig", "documentation":"The content filter policies to configure for the AI Guardrail.
" }, "contextualGroundingPolicyConfig":{ "shape":"AIGuardrailContextualGroundingPolicyConfig", "documentation":"The contextual grounding policy configuration used to create an AI Guardrail.
" }, "description":{ "shape":"AIGuardrailDescription", "documentation":"A description of the AI Guardrail.
" }, "sensitiveInformationPolicyConfig":{ "shape":"AIGuardrailSensitiveInformationPolicyConfig", "documentation":"The sensitive information policy to configure for the AI Guardrail.
" }, "topicPolicyConfig":{ "shape":"AIGuardrailTopicPolicyConfig", "documentation":"The topic policies to configure for the AI Guardrail.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the Amazon Q in Connect AI Guardrail.
" }, "wordPolicyConfig":{ "shape":"AIGuardrailWordPolicyConfig", "documentation":"The word policy you configure for the AI Guardrail.
" } } }, "UpdateAIGuardrailResponse":{ "type":"structure", "members":{ "aiGuardrail":{ "shape":"AIGuardrailData", "documentation":"The data of the updated Amazon Q in Connect AI Guardrail.
" } } }, "UpdateAIPromptRequest":{ "type":"structure", "required":[ "aiPromptId", "assistantId", "visibilityStatus" ], "members":{ "aiPromptId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the Amazon Q in Connect AI Prompt.
", "location":"uri", "locationName":"aiPromptId" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "clientToken":{ "shape":"ClientToken", "documentation":"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..
", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"The description of the Amazon Q in Connect AI Prompt.
" }, "templateConfiguration":{ "shape":"AIPromptTemplateConfiguration", "documentation":"The configuration of the prompt template for this AI Prompt.
" }, "visibilityStatus":{ "shape":"VisibilityStatus", "documentation":"The visibility status of the Amazon Q in Connect AI prompt.
" } } }, "UpdateAIPromptResponse":{ "type":"structure", "members":{ "aiPrompt":{ "shape":"AIPromptData", "documentation":"The data of the updated Amazon Q in Connect AI Prompt.
" } } }, "UpdateAssistantAIAgentRequest":{ "type":"structure", "required":[ "aiAgentType", "assistantId", "configuration" ], "members":{ "aiAgentType":{ "shape":"AIAgentType", "documentation":"The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "configuration":{ "shape":"AIAgentConfigurationData", "documentation":"The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" } } }, "UpdateAssistantAIAgentResponse":{ "type":"structure", "members":{ "assistant":{"shape":"AssistantData"} } }, "UpdateContentRequest":{ "type":"structure", "required":[ "contentId", "knowledgeBaseId" ], "members":{ "contentId":{ "shape":"UuidOrArn", "documentation":"The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"contentId" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
", "location":"uri", "locationName":"knowledgeBaseId" }, "metadata":{ "shape":"ContentMetadata", "documentation":"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.
" }, "overrideLinkOutUri":{ "shape":"Uri", "documentation":"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.
Unset the existing overrideLinkOutUri if it exists.
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 title of the content.
" }, "uploadId":{ "shape":"UploadId", "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" } } }, "UpdateContentResponse":{ "type":"structure", "members":{ "content":{ "shape":"ContentData", "documentation":"The content.
" } } }, "UpdateKnowledgeBaseTemplateUriRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "templateUri" ], "members":{ "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"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.
", "location":"uri", "locationName":"knowledgeBaseId" }, "templateUri":{ "shape":"Uri", "documentation":"The template URI to update.
" } } }, "UpdateKnowledgeBaseTemplateUriResponse":{ "type":"structure", "members":{ "knowledgeBase":{ "shape":"KnowledgeBaseData", "documentation":"The knowledge base to update.
" } } }, "UpdateMessageTemplateMetadataRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "description":{ "shape":"Description", "documentation":"The description of the message template.
" }, "groupingConfiguration":{"shape":"GroupingConfiguration"}, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "messageTemplateId":{ "shape":"UuidOrArnOrEitherWithQualifier", "documentation":"The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" }, "name":{ "shape":"Name", "documentation":"The name of the message template.
" } } }, "UpdateMessageTemplateMetadataResponse":{ "type":"structure", "members":{ "messageTemplate":{ "shape":"MessageTemplateData", "documentation":"The message template.
" } } }, "UpdateMessageTemplateRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "messageTemplateId" ], "members":{ "content":{ "shape":"MessageTemplateContentProvider", "documentation":"The content of the message template.
" }, "defaultAttributes":{ "shape":"MessageTemplateAttributes", "documentation":"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.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "language":{ "shape":"LanguageCode", "documentation":"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 message template. Can be either the ID or the ARN. It cannot contain any qualifier.
", "location":"uri", "locationName":"messageTemplateId" } } }, "UpdateMessageTemplateResponse":{ "type":"structure", "members":{ "messageTemplate":{ "shape":"MessageTemplateData", "documentation":"The message template.
" } } }, "UpdateQuickResponseRequest":{ "type":"structure", "required":[ "knowledgeBaseId", "quickResponseId" ], "members":{ "channels":{ "shape":"Channels", "documentation":"The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The updated content of the quick response.
" }, "contentType":{ "shape":"QuickResponseType", "documentation":"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 updated description of the quick response.
" }, "groupingConfiguration":{ "shape":"GroupingConfiguration", "documentation":"The updated grouping configuration of the quick response.
" }, "isActive":{ "shape":"Boolean", "documentation":"Whether the quick response is active.
" }, "knowledgeBaseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"knowledgeBaseId" }, "language":{ "shape":"LanguageCode", "documentation":"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 name of the quick response.
" }, "quickResponseId":{ "shape":"UuidOrArn", "documentation":"The identifier of the quick response.
", "location":"uri", "locationName":"quickResponseId" }, "removeDescription":{ "shape":"Boolean", "documentation":"Whether to remove the description from the quick response.
" }, "removeGroupingConfiguration":{ "shape":"Boolean", "documentation":"Whether to remove the grouping configuration of the quick response.
" }, "removeShortcutKey":{ "shape":"Boolean", "documentation":"Whether to remove the shortcut key of the quick response.
" }, "shortcutKey":{ "shape":"ShortCutKey", "documentation":"The shortcut key of the quick response. The value should be unique across the knowledge base.
" } } }, "UpdateQuickResponseResponse":{ "type":"structure", "members":{ "quickResponse":{ "shape":"QuickResponseData", "documentation":"The quick response.
" } } }, "UpdateSessionDataRequest":{ "type":"structure", "required":[ "assistantId", "data", "sessionId" ], "members":{ "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "data":{ "shape":"RuntimeSessionDataList", "documentation":"The data stored on the Amazon Q in Connect Session.
" }, "namespace":{ "shape":"SessionDataNamespace", "documentation":"The namespace into which the session data is stored. Supported namespaces are: Custom
" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"sessionId" } } }, "UpdateSessionDataResponse":{ "type":"structure", "required":[ "data", "namespace", "sessionArn", "sessionId" ], "members":{ "data":{ "shape":"RuntimeSessionDataList", "documentation":"Data stored in the session.
" }, "namespace":{ "shape":"SessionDataNamespace", "documentation":"The namespace into which the session data is stored. Supported namespaces are: Custom
" }, "sessionArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the session.
" }, "sessionId":{ "shape":"Uuid", "documentation":"The identifier of the session.
" } } }, "UpdateSessionRequest":{ "type":"structure", "required":[ "assistantId", "sessionId" ], "members":{ "aiAgentConfiguration":{ "shape":"AIAgentConfigurationMap", "documentation":"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.
" }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"assistantId" }, "description":{ "shape":"Description", "documentation":"The description.
" }, "sessionId":{ "shape":"UuidOrArn", "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "location":"uri", "locationName":"sessionId" }, "tagFilter":{ "shape":"TagFilter", "documentation":"An object that can be used to specify Tag conditions.
" } } }, "UpdateSessionResponse":{ "type":"structure", "members":{ "session":{"shape":"SessionData"} } }, "UploadId":{ "type":"string", "max":1200, "min":1 }, "Uri":{ "type":"string", "max":4096, "min":1 }, "Url":{ "type":"string", "max":4096, "min":1, "sensitive":true }, "UrlConfiguration":{ "type":"structure", "members":{ "seedUrls":{ "shape":"SeedUrls", "documentation":"List of URLs for crawling.
" } }, "documentation":"The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" }, "UrlFilterList":{ "type":"list", "member":{"shape":"UrlFilterPattern"}, "max":25, "min":1, "sensitive":true }, "UrlFilterPattern":{ "type":"string", "max":1000, "min":1, "sensitive":true }, "Uuid":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "UuidOrArn":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" }, "UuidOrArnOrEitherWithQualifier":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$" }, "UuidWithQualifier":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$" }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"The input fails to satisfy the constraints specified by a service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "VectorIngestionConfiguration":{ "type":"structure", "members":{ "chunkingConfiguration":{ "shape":"ChunkingConfiguration", "documentation":"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.
" }, "parsingConfiguration":{ "shape":"ParsingConfiguration", "documentation":"A custom parser for data source documents.
" } }, "documentation":"Contains details about how to ingest the documents in a data source.
" }, "Version":{ "type":"long", "box":true, "min":1 }, "VisibilityStatus":{ "type":"string", "enum":[ "SAVED", "PUBLISHED" ] }, "WaitTimeSeconds":{ "type":"integer", "max":20, "min":0 }, "WebCrawlerConfiguration":{ "type":"structure", "required":["urlConfiguration"], "members":{ "crawlerLimits":{ "shape":"WebCrawlerLimits", "documentation":"The configuration of crawl limits for the web URLs.
" }, "exclusionFilters":{ "shape":"UrlFilterList", "documentation":"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.
" }, "inclusionFilters":{ "shape":"UrlFilterList", "documentation":"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.
" }, "scope":{ "shape":"WebScopeType", "documentation":"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.
The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" } }, "documentation":"The configuration details for the web data source.
" }, "WebCrawlerLimits":{ "type":"structure", "members":{ "rateLimit":{ "shape":"WebCrawlerLimitsRateLimitInteger", "documentation":"Rate of web URLs retrieved per minute.
" } }, "documentation":"The configuration of crawl limits for the web URLs.
" }, "WebCrawlerLimitsRateLimitInteger":{ "type":"integer", "box":true, "max":300, "min":1 }, "WebScopeType":{ "type":"string", "enum":[ "HOST_ONLY", "SUBDOMAINS" ] }, "WebUrl":{ "type":"string", "pattern":"^https?://[A-Za-z0-9][^\\s]*$" } }, "documentation":"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.
" }