The job template to use for this job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The job template to use for this job.
" } }, "templateType": { "target": "com.amazonaws.deadline#JobTemplateType", "traits": { - "smithy.api#documentation": "The file type for the job template.
", - "smithy.api#required": {} + "smithy.api#documentation": "The file type for the job template.
" } }, "priority": { @@ -2575,6 +2573,12 @@ "smithy.api#default": 5, "smithy.api#documentation": "The maximum number of retries for each task.
" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "The job ID for the source job.
" + } } }, "traits": { @@ -7570,6 +7574,12 @@ "traits": { "smithy.api#documentation": "The description of the job.
\nThis field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
\nThe job ID for the source job.
" + } } }, "traits": { @@ -10328,6 +10338,15 @@ "smithy.api#documentation": "The details of job parameters.
" } }, + "com.amazonaws.deadline#JobParameterDefinition": { + "type": "document" + }, + "com.amazonaws.deadline#JobParameterDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.deadline#JobParameterDefinition" + } + }, "com.amazonaws.deadline#JobParameters": { "type": "map", "key": { @@ -10399,6 +10418,9 @@ { "target": "com.amazonaws.deadline#ListJobMembers" }, + { + "target": "com.amazonaws.deadline#ListJobParameterDefinitions" + }, { "target": "com.amazonaws.deadline#ListSessionActions" }, @@ -10573,6 +10595,12 @@ "traits": { "smithy.api#documentation": "The job parameters.
" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "The job ID for the source job.
" + } } }, "traits": { @@ -10690,6 +10718,12 @@ "traits": { "smithy.api#documentation": "The maximum number of retries for a job.
" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "The job ID for the source job.
" + } } }, "traits": { @@ -11651,6 +11685,125 @@ "smithy.api#output": {} } }, + "com.amazonaws.deadline#ListJobParameterDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.deadline#ListJobParameterDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.deadline#ListJobParameterDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.deadline#AccessDeniedException" + }, + { + "target": "com.amazonaws.deadline#InternalServerErrorException" + }, + { + "target": "com.amazonaws.deadline#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.deadline#ThrottlingException" + }, + { + "target": "com.amazonaws.deadline#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "ListJobParameterDefinitions", + "documentation": "Grants permission to get a job's parameter definitions in the job template", + "requiredActions": [ + "identitystore:ListGroupMembershipsForMember" + ] + }, + "smithy.api#documentation": "Lists parameter definitions of a job.
", + "smithy.api#endpoint": { + "hostPrefix": "management." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/parameter-definitions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobParameterDefinitions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.deadline#ListJobParameterDefinitionsRequest": { + "type": "structure", + "members": { + "farmId": { + "target": "com.amazonaws.deadline#FarmId", + "traits": { + "smithy.api#documentation": "The farm ID of the job to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "The job ID to include on the list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "queueId": { + "target": "com.amazonaws.deadline#QueueId", + "traits": { + "smithy.api#documentation": "The queue ID to include on the list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null to start from the beginning.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Lists parameter definitions of a job.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
The AWS Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard\n programmatically. The API gets the agreement and cost analysis dashboards with data for all of the Amazon Web Services accounts in your Amazon Web Services organization.
To use the API, you must complete the following prerequisites:
\nEnable all features for your organization. For more information, see \n Enabling all features for an organization with Amazon Web Services Organizations, \n in the Amazon Web Services Organizations User Guide.
\nCall the service as the Amazon Web Services Organizations management account or an account registered as a delegated administrator for the procurement insights service. \n Users without management or delegated administrator accounts can use the dashboard, but they only see data for their accounts.
\nFor more information about management accounts, see \n Tutorial: Creating and configuring an organization \n and Managing the management account with Amazon Web Services Organizations, \n both in the Amazon Web Services Organizations User Guide.
\nFor more information about delegated administrators, see Using delegated administrators, \n in the AWS Marketplace Buyer Guide.
\nCreate an IAM policy that enables the aws-marketplace:GetBuyerDashboard and organizations:DescribeOrganization permissions. In addition, \n the management account requires the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create \n For more information about creating the policy, see \n Policies and permissions in Amazon Web Services Identity and Access Management, \n in the IAM User Guide.
Use the Amazon Web Services Marketplace console to create the AWSServiceRoleForProcurementInsightsPolicy service-linked role. \n The role enables AWS Marketplace procurement visibility integration. The management account requires an IAM policy with the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions \n to create the service-linked role and enable the service access. For more information, see \n Granting access to \n Amazon Web Services Organizations, and \n Service-linked role to share procurement data, \n in the Amazon Web Services Marketplace Buyer Guide.
The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights\n dashboard programmatically. The API gets the agreement and cost analysis dashboards with\n data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.
To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:
\nEnable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the\n Organizations User Guide.
\nCall the service as the Organizations management account or an account registered\n as a delegated administrator for the procurement insights service.
\nFor more information about management accounts, see Tutorial:\n Creating and configuring an organization and Managing the management account with Organizations, both in the\n Organizations User Guide.
\nFor more information about delegated administrators, see Using\n delegated administrators, in the Amazon Web Services Marketplace Buyer\n Guide.
\nCreate an IAM policy that enables the\n aws-marketplace:GetBuyerDashboard and\n organizations:DescribeOrganization permissions. In addition,\n the management account requires the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create. For more\n information about creating the policy, see Policies and permissions in\n Identity and Access Management, in the IAM User Guide.
Access can be shared only by registering the desired linked account as a\n delegated administrator. That requires\n organizations:RegisterDelegatedAdministrator\n organizations:ListDelegatedAdministrators and\n organizations:DeregisterDelegatedAdministrator\n permissions.
Use the Amazon Web Services Marketplace console to create the\n AWSServiceRoleForProcurementInsightsPolicy service-linked role.\n The role enables Amazon Web Services Marketplace procurement visibility integration. The management\n account requires an IAM policy with the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create the\n service-linked role and enable the service access. For more information, see\n Granting access to\n Organizations and Service-linked role to share procurement data in the\n Amazon Web Services Marketplace Buyer Guide.
After creating the service-linked role, you must enable trusted access that\n grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,\n see Granting access to\n Organizations in the Amazon Web Services Marketplace Buyer Guide.
\nGenerates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
\nThe following rules apply to a generated URL:
\nIt contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.
\nIt has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.
\nGenerates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
\nThis API is available only to Amazon Web Services Organization management accounts or\n delegated administrators registered for the procurement insights\n (procurement-insights.marketplace.amazonaws.com) feature.
The following rules apply to a generated URL:
\nIt contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.
\nIt has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.
\nFully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
Fully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
The fully qualified domains specified in the request. The domains enable access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
The fully qualified domains specified in the request. The domains enable access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.
You do not have sufficient access to perform this action.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.qconnect#AmazonConnectGuideAssociationData": { - "type": "structure", - "members": { - "flowId": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Content association data for a step-by-step\n guide.
" - } - }, - "com.amazonaws.qconnect#AndConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#TagCondition" - } - }, - "com.amazonaws.qconnect#AppIntegrationsConfiguration": { - "type": "structure", - "members": { - "appIntegrationArn": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
\n For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least number,\n short_description, sys_mod_count, workflow_state,\n and active as source fields.
For \n Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least id,\n title, updated_at, and draft as source fields.\n
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration,\n including only file extensions that are among docx, pdf,\n html, htm, and txt.
For Amazon S3, the\n ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.\n The SourceURI of your DataIntegration must use the following format:\n s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services\n principal app-integrations.amazonaws.com to perform\n s3:ListBucket, s3:GetObject, and\n s3:GetBucketLocation against the bucket.
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.
\n For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.
For \n Zendesk, you must include at least id, title,\n updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source\n recommendations.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" - } - }, - "com.amazonaws.qconnect#Arn": { - "type": "string", - "traits": { - "smithy.api#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}$" - } - }, - "com.amazonaws.qconnect#Assistant": { + "com.amazonaws.qconnect#AIAgent": { "type": "resource", "identifiers": { "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier" } }, "create": { - "target": "com.amazonaws.qconnect#CreateAssistant" + "target": "com.amazonaws.qconnect#CreateAIAgent" }, "read": { - "target": "com.amazonaws.qconnect#GetAssistant" + "target": "com.amazonaws.qconnect#GetAIAgent" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateAIAgent" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteAssistant" + "target": "com.amazonaws.qconnect#DeleteAIAgent" }, "list": { - "target": "com.amazonaws.qconnect#ListAssistants" + "target": "com.amazonaws.qconnect#ListAIAgents" }, "operations": [ { - "target": "com.amazonaws.qconnect#GetRecommendations" - }, - { - "target": "com.amazonaws.qconnect#NotifyRecommendationsReceived" - }, - { - "target": "com.amazonaws.qconnect#PutFeedback" - }, - { - "target": "com.amazonaws.qconnect#QueryAssistant" + "target": "com.amazonaws.qconnect#CreateAIAgentVersion" }, { - "target": "com.amazonaws.qconnect#SearchSessions" - } - ], - "resources": [ - { - "target": "com.amazonaws.qconnect#AssistantAssociation" + "target": "com.amazonaws.qconnect#DeleteAIAgentVersion" }, { - "target": "com.amazonaws.qconnect#Session" + "target": "com.amazonaws.qconnect#ListAIAgentVersions" } ], "traits": { "aws.api#arn": { - "template": "assistant/{assistantId}" + "template": "ai-agent/{assistantId}/{aiAgentId}" }, - "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#AssistantAssociation": { - "type": "resource", - "identifiers": { - "assistantId": { - "target": "com.amazonaws.qconnect#UuidOrArn" + "com.amazonaws.qconnect#AIAgentAssociationConfigurationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" + } + ] + } + }, + "com.amazonaws.qconnect#AIAgentConfiguration": { + "type": "union", + "members": { + "manualSearchAIAgentConfiguration": { + "target": "com.amazonaws.qconnect#ManualSearchAIAgentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for AI Agents of type MANUAL_SEARCH.
The configuration for AI Agents of type ANSWER_RECOMMENDATION.
A typed union that specifies the configuration based on the type of AI Agent.
" + } + }, + "com.amazonaws.qconnect#AIAgentConfigurationData": { + "type": "structure", + "members": { + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "The ID of the AI Agent to be configured.
", + "smithy.api#required": {} + } + } }, "traits": { - "aws.api#arn": { - "template": "association/{assistantId}/{assistantAssociationId}" - }, - "aws.cloudformation#cfnResource": {}, - "aws.iam#disableConditionKeyInference": {} + "smithy.api#documentation": "A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be\n used for an AI Agent type on a session or assistant.
" } }, - "com.amazonaws.qconnect#AssistantAssociationData": { + "com.amazonaws.qconnect#AIAgentConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#AIAgentType" + }, + "value": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationData" + } + }, + "com.amazonaws.qconnect#AIAgentData": { "type": "structure", "members": { - "assistantAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the assistant association.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", "smithy.api#required": {} } }, - "assistantAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "assistantId": { + "aiAgentId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The identifier of the AI Agent.
", "smithy.api#required": {} } }, - "assistantArn": { + "aiAgentArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AI agent.
", "smithy.api#required": {} } }, - "associationType": { - "target": "com.amazonaws.qconnect#AssociationType", + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The type of association.
", + "smithy.api#documentation": "The name of the AI Agent.
", "smithy.api#required": {} } }, - "associationData": { - "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "A union type that currently has a single argument, the knowledge base ID.
", + "smithy.api#documentation": "The type of the AI Agent.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for the AI Agent.
", + "smithy.api#required": {} + } + }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the AI Agent was last modified.
" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the AI Agent.
" + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "The visibility status of the AI Agent.
", "smithy.api#required": {} } }, @@ -193,148 +175,239 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created\n by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation\n APIs.
The status of the AI Agent.
" + } } }, "traits": { - "smithy.api#documentation": "Information about the assistant association.
", + "smithy.api#documentation": "The data for the AI Agent.
", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#AssistantAssociation" + "resource": "com.amazonaws.qconnect#AIAgent" } ] } }, - "com.amazonaws.qconnect#AssistantAssociationInputData": { - "type": "union", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The data that is input into Amazon Q in Connect as a result of the assistant association.
" - } - }, - "com.amazonaws.qconnect#AssistantAssociationOutputData": { - "type": "union", + "com.amazonaws.qconnect#AIAgentSummary": { + "type": "structure", "members": { - "knowledgeBaseAssociation": { - "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationData", + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The knowledge base where output data is sent.
" + "smithy.api#documentation": "The name of the AI Agent.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "The data that is output as a result of the assistant association.
" - } - }, - "com.amazonaws.qconnect#AssistantAssociationSummary": { - "type": "structure", - "members": { - "assistantAssociationId": { + }, + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the assistant association.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", "smithy.api#required": {} } }, - "assistantAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "assistantId": { + "aiAgentId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The identifier of the AI Agent.
", "smithy.api#required": {} } }, - "assistantArn": { - "target": "com.amazonaws.qconnect#Arn", + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The type of the AI Agent.
", "smithy.api#required": {} } }, - "associationType": { - "target": "com.amazonaws.qconnect#AssociationType", + "aiAgentArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The type of association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AI agent.
", "smithy.api#required": {} } }, - "associationData": { - "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The association data.
", + "smithy.api#documentation": "The time the AI Agent was last modified.
" + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "The visibility status of the AI Agent.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + "smithy.api#documentation": "The configuration for the AI Agent.
" } - } - }, - "traits": { - "smithy.api#documentation": "Summary information about the assistant association.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#AssistantAssociation" + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in\n Connect or CUSTOMER for an AI Agent created by calling AI Agent creation\n APIs.
The description of the AI Agent.
" + } + }, + "status": { + "target": "com.amazonaws.qconnect#Status", + "traits": { + "smithy.api#documentation": "The status of the AI Agent.
" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the AI Agent.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIAgent" } ] } }, - "com.amazonaws.qconnect#AssistantAssociationSummaryList": { + "com.amazonaws.qconnect#AIAgentSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#AssistantAssociationSummary" + "target": "com.amazonaws.qconnect#AIAgentSummary" } }, - "com.amazonaws.qconnect#AssistantCapabilityConfiguration": { + "com.amazonaws.qconnect#AIAgentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL_SEARCH", + "name": "MANUAL_SEARCH" + }, + { + "value": "ANSWER_RECOMMENDATION", + "name": "ANSWER_RECOMMENDATION" + } + ] + } + }, + "com.amazonaws.qconnect#AIAgentVersionSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AIAgentVersionSummary" + } + }, + "com.amazonaws.qconnect#AIAgentVersionSummary": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.qconnect#AssistantCapabilityType", + "aiAgentSummary": { + "target": "com.amazonaws.qconnect#AIAgentSummary", "traits": { - "smithy.api#documentation": "The type of Amazon Q in Connect assistant capability.
" + "smithy.api#documentation": "The data for the summary of the AI Agent version.
" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number for this AI Agent version.
" } } }, "traits": { - "smithy.api#documentation": "The capability configuration for an Amazon Q in Connect assistant.
" + "smithy.api#documentation": "The summary of the AI Agent version.
" } }, - "com.amazonaws.qconnect#AssistantCapabilityType": { + "com.amazonaws.qconnect#AIPrompt": { + "type": "resource", + "identifiers": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateAIPrompt" + }, + "read": { + "target": "com.amazonaws.qconnect#GetAIPrompt" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateAIPrompt" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteAIPrompt" + }, + "list": { + "target": "com.amazonaws.qconnect#ListAIPrompts" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#CreateAIPromptVersion" + }, + { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersion" + }, + { + "target": "com.amazonaws.qconnect#ListAIPromptVersions" + } + ], + "traits": { + "aws.api#arn": { + "template": "ai-prompt/{assistantId}/{aiPromptId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#AIPromptAPIFormat": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "V1", - "name": "V1" + "value": "ANTHROPIC_CLAUDE_MESSAGES", + "name": "ANTHROPIC_CLAUDE_MESSAGES" }, { - "value": "V2", - "name": "V2" + "value": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", + "name": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" } ] } }, - "com.amazonaws.qconnect#AssistantData": { + "com.amazonaws.qconnect#AIPromptData": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", "smithy.api#required": {} } }, @@ -345,120 +418,132 @@ "smithy.api#required": {} } }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt.
", + "smithy.api#required": {} + } + }, + "aiPromptArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AI Prompt.
", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The name.
", + "smithy.api#documentation": "The name of the AI Prompt
", "smithy.api#required": {} } }, "type": { - "target": "com.amazonaws.qconnect#AssistantType", + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "The type of assistant.
", + "smithy.api#documentation": "The type of this AI Prompt.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#AssistantStatus", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "The status of the assistant.
", + "smithy.api#documentation": "The type of the prompt template for this AI Prompt.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1.
The API format used for this AI Prompt.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the prompt template for this AI Prompt.
", "smithy.api#required": {} } }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the AI Prompt was last modified.
" + } + }, "description": { "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "The description.
" + "smithy.api#documentation": "The description of the AI Prompt.
" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + "smithy.api#documentation": "The visibility status of the AI Prompt.
", + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "tags": { + "target": "com.amazonaws.qconnect#Tags", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, - "integrationConfiguration": { - "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" + "smithy.api#documentation": "The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in\n Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.\n
The configuration information for the Amazon Q in Connect assistant capability.
" + "smithy.api#documentation": "The status of the AI Prompt.
" } } }, "traits": { - "smithy.api#documentation": "The assistant data.
" - } - }, - "com.amazonaws.qconnect#AssistantIntegrationConfiguration": { - "type": "structure", - "members": { - "topicIntegrationArn": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" + "smithy.api#documentation": "The data for the AI Prompt
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIPrompt" } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" - } - }, - "com.amazonaws.qconnect#AssistantList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#AssistantSummary" + ] } }, - "com.amazonaws.qconnect#AssistantStatus": { + "com.amazonaws.qconnect#AIPromptModelIdentifier": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] + "smithy.api#length": { + "min": 1, + "max": 2048 + } } }, - "com.amazonaws.qconnect#AssistantSummary": { + "com.amazonaws.qconnect#AIPromptSummary": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "The name of the AI Prompt.
", + "smithy.api#required": {} + } + }, "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", "smithy.api#required": {} } }, @@ -469,127 +554,172 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.qconnect#Name", + "aiPromptId": { + "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The name of the assistant.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt.
", "smithy.api#required": {} } }, "type": { - "target": "com.amazonaws.qconnect#AssistantType", + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "The type of the assistant.
", + "smithy.api#documentation": "The type of this AI Prompt.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#AssistantStatus", + "aiPromptArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The status of the assistant.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AI Prompt.
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.qconnect#Description", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The description of the assistant.
" + "smithy.api#documentation": "The time the AI Prompt was last modified.
" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + "smithy.api#documentation": "The type of the prompt template for this AI Prompt.
", + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" + "smithy.api#documentation": "The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1.
The configuration information for the Amazon Q in Connect assistant integration.
" + "smithy.api#documentation": "The API format used for this AI Prompt.
", + "smithy.api#required": {} } }, - "capabilityConfiguration": { - "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant capability.
" + "smithy.api#documentation": "The visibility status of the AI Prompt.
", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in\n Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.\n
The description of the AI Prompt.
" + } + }, + "status": { + "target": "com.amazonaws.qconnect#Status", + "traits": { + "smithy.api#documentation": "The status of the AI Prompt.
" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { - "smithy.api#documentation": "Summary information about the assistant.
" + "smithy.api#documentation": "The summary of the AI Prompt.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIPrompt" + } + ] } }, - "com.amazonaws.qconnect#AssistantType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AGENT", - "name": "AGENT" + "com.amazonaws.qconnect#AIPromptSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AIPromptSummary" + } + }, + "com.amazonaws.qconnect#AIPromptTemplateConfiguration": { + "type": "union", + "members": { + "textFullAIPromptEditTemplateConfiguration": { + "target": "com.amazonaws.qconnect#TextFullAIPromptEditTemplateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a prompt template that supports full textual prompt configuration\n using a YAML prompt.
" } - ] + } + }, + "traits": { + "smithy.api#documentation": "A typed union that specifies the configuration for a prompt template based on its\n type.
" } }, - "com.amazonaws.qconnect#AssociationType": { + "com.amazonaws.qconnect#AIPromptTemplateType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "KNOWLEDGE_BASE", - "name": "KNOWLEDGE_BASE" + "value": "TEXT", + "name": "TEXT" } ] } }, - "com.amazonaws.qconnect#Channel": { + "com.amazonaws.qconnect#AIPromptType": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#sensitive": {} + "smithy.api#enum": [ + { + "value": "ANSWER_GENERATION", + "name": "ANSWER_GENERATION" + }, + { + "value": "INTENT_LABELING_GENERATION", + "name": "INTENT_LABELING_GENERATION" + }, + { + "value": "QUERY_REFORMULATION", + "name": "QUERY_REFORMULATION" + } + ] } }, - "com.amazonaws.qconnect#Channels": { + "com.amazonaws.qconnect#AIPromptVersionSummariesList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#Channel" - }, - "traits": { - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.qconnect#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } + "target": "com.amazonaws.qconnect#AIPromptVersionSummary" } }, - "com.amazonaws.qconnect#Configuration": { - "type": "union", + "com.amazonaws.qconnect#AIPromptVersionSummary": { + "type": "structure", "members": { - "connectConfiguration": { - "target": "com.amazonaws.qconnect#ConnectConfiguration", + "aiPromptSummary": { + "target": "com.amazonaws.qconnect#AIPromptSummary", "traits": { - "smithy.api#documentation": "The configuration information of the Amazon Connect data source.
" + "smithy.api#documentation": "The date for the summary of the AI Prompt version.
" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number for this AI Prompt version.
" } } }, "traits": { - "smithy.api#documentation": "The configuration information of the external data source.
" + "smithy.api#documentation": "The summary of the AI Prompt version.
" } }, - "com.amazonaws.qconnect#ConflictException": { + "com.amazonaws.qconnect#AccessDeniedException": { "type": "structure", "members": { "message": { @@ -597,197 +727,226 @@ } }, "traits": { - "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the\n resource. For example, if you're using a Create API (such as\n CreateAssistant) that accepts name, a conflicting resource (usually with the\n same name) is being created or mutated.
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#httpError": 403 } }, - "com.amazonaws.qconnect#ConnectConfiguration": { + "com.amazonaws.qconnect#AmazonConnectGuideAssociationData": { "type": "structure", "members": { - "instanceId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "flowId": { + "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" } } }, "traits": { - "smithy.api#documentation": "The configuration information of the Amazon Connect data source.
" + "smithy.api#documentation": "Content association data for a step-by-step\n guide.
" } }, - "com.amazonaws.qconnect#ContactAttributeKey": { - "type": "string" - }, - "com.amazonaws.qconnect#ContactAttributeKeys": { + "com.amazonaws.qconnect#AndConditions": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#ContactAttributeKey" + "target": "com.amazonaws.qconnect#TagCondition" + } + }, + "com.amazonaws.qconnect#AnswerRecommendationAIAgentConfiguration": { + "type": "structure", + "members": { + "intentLabelingGenerationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "The AI Prompt identifier for the Intent Labeling prompt used by the\n ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Query Reformulation prompt used by the\n ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Answer Generation prompt used by the\n ANSWER_RECOMMENDATION AI Agent.
The association configurations for overriding behavior on this AI Agent.
" + } + } }, "traits": { - "smithy.api#sensitive": {}, - "smithy.api#uniqueItems": {} + "smithy.api#documentation": "The configuration for the ANSWER_RECOMMENDATION AI Agent type.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
\n For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least number,\n short_description, sys_mod_count, workflow_state,\n and active as source fields.
For \n Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least id,\n title, updated_at, and draft as source fields.\n
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration,\n including only file extensions that are among docx, pdf,\n html, htm, and txt.
For Amazon S3, the\n ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.\n The SourceURI of your DataIntegration must use the following format:\n s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services\n principal app-integrations.amazonaws.com to perform\n s3:ListBucket, s3:GetObject, and\n s3:GetBucketLocation against the bucket.
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.
\n For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.
For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.
For \n Zendesk, you must include at least id, title,\n updated_at, and draft.
Make sure to include additional fields. These fields are indexed and used to source\n recommendations.
" + } + } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" } }, - "com.amazonaws.qconnect#Content": { + "com.amazonaws.qconnect#Arn": { + "type": "string", + "traits": { + "smithy.api#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}$" + } + }, + "com.amazonaws.qconnect#Assistant": { "type": "resource", "identifiers": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#UuidOrArn" - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" } }, "create": { - "target": "com.amazonaws.qconnect#CreateContent" + "target": "com.amazonaws.qconnect#CreateAssistant" }, "read": { - "target": "com.amazonaws.qconnect#GetContent" - }, - "update": { - "target": "com.amazonaws.qconnect#UpdateContent" + "target": "com.amazonaws.qconnect#GetAssistant" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteContent" + "target": "com.amazonaws.qconnect#DeleteAssistant" }, "list": { - "target": "com.amazonaws.qconnect#ListContents" + "target": "com.amazonaws.qconnect#ListAssistants" }, "operations": [ { - "target": "com.amazonaws.qconnect#GetContentSummary" + "target": "com.amazonaws.qconnect#GetRecommendations" + }, + { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceived" + }, + { + "target": "com.amazonaws.qconnect#PutFeedback" + }, + { + "target": "com.amazonaws.qconnect#QueryAssistant" + }, + { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgent" + }, + { + "target": "com.amazonaws.qconnect#SearchSessions" + }, + { + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgent" } ], "resources": [ { - "target": "com.amazonaws.qconnect#ContentAssociation" + "target": "com.amazonaws.qconnect#AIAgent" + }, + { + "target": "com.amazonaws.qconnect#AIPrompt" + }, + { + "target": "com.amazonaws.qconnect#AssistantAssociation" + }, + { + "target": "com.amazonaws.qconnect#Session" } ], "traits": { "aws.api#arn": { - "template": "content/{knowledgeBaseId}/{contentId}" + "template": "assistant/{assistantId}" }, + "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#ContentAssociation": { + "com.amazonaws.qconnect#AssistantAssociation": { "type": "resource", "identifiers": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#UuidOrArn" - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" }, - "contentAssociationId": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#UuidOrArn" } }, "create": { - "target": "com.amazonaws.qconnect#CreateContentAssociation" + "target": "com.amazonaws.qconnect#CreateAssistantAssociation" }, "read": { - "target": "com.amazonaws.qconnect#GetContentAssociation" + "target": "com.amazonaws.qconnect#GetAssistantAssociation" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteContentAssociation" + "target": "com.amazonaws.qconnect#DeleteAssistantAssociation" }, "list": { - "target": "com.amazonaws.qconnect#ListContentAssociations" + "target": "com.amazonaws.qconnect#ListAssistantAssociations" }, "traits": { "aws.api#arn": { - "template": "content-association/{knowledgeBaseId}/{contentId}/{contentAssociationId}" + "template": "association/{assistantId}/{assistantAssociationId}" }, + "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#ContentAssociationContents": { - "type": "union", - "members": { - "amazonConnectGuideAssociation": { - "target": "com.amazonaws.qconnect#AmazonConnectGuideAssociationData", - "traits": { - "smithy.api#documentation": "The data of the step-by-step guide association.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The contents of a content association.
" - } - }, - "com.amazonaws.qconnect#ContentAssociationData": { + "com.amazonaws.qconnect#AssistantAssociationData": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "The identifier of the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} - } - }, - "contentId": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#documentation": "The identifier of the assistant association.
", "smithy.api#required": {} } }, - "contentArn": { + "assistantAssociationArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", "smithy.api#required": {} } }, - "contentAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "contentAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "associationType": { - "target": "com.amazonaws.qconnect#ContentAssociationType", + "target": "com.amazonaws.qconnect#AssociationType", "traits": { "smithy.api#documentation": "The type of association.
", "smithy.api#required": {} } }, "associationData": { - "target": "com.amazonaws.qconnect#ContentAssociationContents", + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", "traits": { - "smithy.api#documentation": "The content association.
", + "smithy.api#documentation": "A union type that currently has a single argument, the knowledge base ID.
", "smithy.api#required": {} } }, @@ -799,70 +958,84 @@ } }, "traits": { - "smithy.api#documentation": "Information about the content association.
", + "smithy.api#documentation": "Information about the assistant association.
", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#ContentAssociation" + "resource": "com.amazonaws.qconnect#AssistantAssociation" } ] } }, - "com.amazonaws.qconnect#ContentAssociationSummary": { - "type": "structure", - "members": { + "com.amazonaws.qconnect#AssistantAssociationInputData": { + "type": "union", + "members": { "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + } + }, + "traits": { + "smithy.api#documentation": "The data that is input into Amazon Q in Connect as a result of the assistant association.
" + } + }, + "com.amazonaws.qconnect#AssistantAssociationOutputData": { + "type": "union", + "members": { + "knowledgeBaseAssociation": { + "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationData", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} + "smithy.api#documentation": "The knowledge base where output data is sent.
" } - }, - "contentId": { + } + }, + "traits": { + "smithy.api#documentation": "The data that is output as a result of the assistant association.
" + } + }, + "com.amazonaws.qconnect#AssistantAssociationSummary": { + "type": "structure", + "members": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#documentation": "The identifier of the assistant association.
", "smithy.api#required": {} } }, - "contentArn": { + "assistantAssociationArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", "smithy.api#required": {} } }, - "contentAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "contentAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "associationType": { - "target": "com.amazonaws.qconnect#ContentAssociationType", + "target": "com.amazonaws.qconnect#AssociationType", "traits": { "smithy.api#documentation": "The type of association.
", "smithy.api#required": {} } }, "associationData": { - "target": "com.amazonaws.qconnect#ContentAssociationContents", + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", "traits": { - "smithy.api#documentation": "The content association.
", + "smithy.api#documentation": "The association data.
", "smithy.api#required": {} } }, @@ -874,332 +1047,1458 @@ } }, "traits": { - "smithy.api#documentation": "Summary information about a content association.
", + "smithy.api#documentation": "Summary information about the assistant association.
", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#ContentAssociation" + "resource": "com.amazonaws.qconnect#AssistantAssociation" } ] } }, - "com.amazonaws.qconnect#ContentAssociationSummaryList": { + "com.amazonaws.qconnect#AssistantAssociationSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#ContentAssociationSummary" + "target": "com.amazonaws.qconnect#AssistantAssociationSummary" } }, - "com.amazonaws.qconnect#ContentAssociationType": { + "com.amazonaws.qconnect#AssistantCapabilityConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.qconnect#AssistantCapabilityType", + "traits": { + "smithy.api#documentation": "The type of Amazon Q in Connect assistant capability.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The capability configuration for an Amazon Q in Connect assistant.
" + } + }, + "com.amazonaws.qconnect#AssistantCapabilityType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "AMAZON_CONNECT_GUIDE", - "name": "AMAZON_CONNECT_GUIDE" + "value": "V1", + "name": "V1" + }, + { + "value": "V2", + "name": "V2" } ] } }, - "com.amazonaws.qconnect#ContentData": { + "com.amazonaws.qconnect#AssistantData": { "type": "structure", "members": { - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", - "smithy.api#required": {} - } - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "knowledgeBaseArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The name of the content.
", + "smithy.api#documentation": "The name.
", "smithy.api#required": {} } }, - "revisionId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "type": { + "target": "com.amazonaws.qconnect#AssistantType", "traits": { - "smithy.api#documentation": "The identifier of the content revision.
", + "smithy.api#documentation": "The type of assistant.
", "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.qconnect#ContentTitle", + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", "traits": { - "smithy.api#documentation": "The title of the content.
", + "smithy.api#documentation": "The status of the assistant.
", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.qconnect#ContentType", + "description": { + "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "The media type of the content.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description.
" } }, - "status": { - "target": "com.amazonaws.qconnect#ContentStatus", + "tags": { + "target": "com.amazonaws.qconnect#Tags", "traits": { - "smithy.api#documentation": "The status of the content.
", - "smithy.api#required": {} + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, - "metadata": { - "target": "com.amazonaws.qconnect#ContentMetadata", + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor 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.
", - "smithy.api#required": {} + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" } }, - "linkOutUri": { - "target": "com.amazonaws.qconnect#Uri", + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "The URI of the content.
" + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant capability.
" } }, - "url": { - "target": "com.amazonaws.qconnect#Url", + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", "traits": { - "smithy.api#documentation": "The URL of the content.
", - "smithy.api#required": {} + "smithy.api#documentation": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is\n set on the Amazon Q in Connect Assistant.
" } - }, - "urlExpiry": { - "target": "smithy.api#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "The assistant data.
" + } + }, + "com.amazonaws.qconnect#AssistantIntegrationConfiguration": { + "type": "structure", + "members": { + "topicIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "The expiration time of the URL as an epoch timestamp.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "epoch-seconds" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } } }, "traits": { - "smithy.api#documentation": "Information about the content.
", - "smithy.api#references": [ + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" + } + }, + "com.amazonaws.qconnect#AssistantList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssistantSummary" + } + }, + "com.amazonaws.qconnect#AssistantStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "resource": "com.amazonaws.qconnect#Content" + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" }, { - "resource": "com.amazonaws.qconnect#KnowledgeBase" + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" } ] } }, - "com.amazonaws.qconnect#ContentDataDetails": { + "com.amazonaws.qconnect#AssistantSummary": { "type": "structure", "members": { - "textData": { - "target": "com.amazonaws.qconnect#TextData", + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "Details about the content text data.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } }, - "rankingData": { - "target": "com.amazonaws.qconnect#RankingData", + "assistantArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "Details about the content ranking data.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Details about the content data.
" - } - }, - "com.amazonaws.qconnect#ContentFeedbackData": { - "type": "union", - "members": { - "generativeContentFeedbackData": { - "target": "com.amazonaws.qconnect#GenerativeContentFeedbackData", + }, + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "Information about the feedback for a generative target type.
" + "smithy.api#documentation": "The name of the assistant.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Information about the feedback.
" - } - }, - "com.amazonaws.qconnect#ContentMetadata": { - "type": "map", + }, + "type": { + "target": "com.amazonaws.qconnect#AssistantType", + "traits": { + "smithy.api#documentation": "The type of the assistant.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", + "traits": { + "smithy.api#documentation": "The status of the assistant.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the assistant.
" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.
" + } + }, + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant integration.
" + } + }, + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the Amazon Q in Connect assistant capability.
" + } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is\n set on the Amazon Q in Connect Assistant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about the assistant.
" + } + }, + "com.amazonaws.qconnect#AssistantType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT", + "name": "AGENT" + } + ] + } + }, + "com.amazonaws.qconnect#AssociationConfiguration": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the association for this Association Configuration.
" + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#AIAgentAssociationConfigurationType", + "traits": { + "smithy.api#documentation": "The type of the association for this Association Configuration.
" + } + }, + "associationConfigurationData": { + "target": "com.amazonaws.qconnect#AssociationConfigurationData", + "traits": { + "smithy.api#documentation": "The data of the configuration for an Amazon Q in Connect Assistant Association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an Amazon Q in Connect Assistant Association.
" + } + }, + "com.amazonaws.qconnect#AssociationConfigurationData": { + "type": "union", + "members": { + "knowledgeBaseAssociationConfigurationData": { + "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationConfigurationData", + "traits": { + "smithy.api#documentation": "The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant\n Association.
A typed union of the data of the configuration for an Amazon Q in Connect Assistant\n Association.
" + } + }, + "com.amazonaws.qconnect#AssociationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssociationConfiguration" + } + }, + "com.amazonaws.qconnect#AssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" + } + ] + } + }, + "com.amazonaws.qconnect#BedrockFoundationModelConfigurationForParsing": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.qconnect#BedrockModelArnForParsing", + "traits": { + "smithy.api#documentation": "The ARN of the foundation model.
", + "smithy.api#required": {} + } + }, + "parsingPrompt": { + "target": "com.amazonaws.qconnect#ParsingPrompt", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + }, + "com.amazonaws.qconnect#BedrockModelArnForParsing": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/anthropic.claude-3-haiku-20240307-v1:0$" + } + }, + "com.amazonaws.qconnect#Channel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#Channel" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.qconnect#ChunkingStrategy", + "traits": { + "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a\n data source that is returned when the knowledge base that it belongs to is queried. You have\n the following options for chunking your data. If you opt for NONE, then you may\n want to pre-process your files by splitting them up such that each file corresponds to a\n chunk.
Configurations for when you choose fixed-size chunking. If you set the\n chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking\n splits documents into layers of chunks where the first layer contains large chunks, and the\n second layer contains smaller chunks derived from the first layer.
" + } + }, + "semanticChunkingConfiguration": { + "target": "com.amazonaws.qconnect#SemanticChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits a\n document into smaller documents based on groups of similar content derived from the text with\n natural language processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt\n from a data source that is returned when the knowledge base that it belongs to is\n queried.
" + } + }, + "com.amazonaws.qconnect#ChunkingStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FIXED_SIZE", + "name": "FIXED_SIZE" + }, + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "HIERARCHICAL", + "name": "HIERARCHICAL" + }, + { + "value": "SEMANTIC", + "name": "SEMANTIC" + } + ] + } + }, + "com.amazonaws.qconnect#CitationSpan": { + "type": "structure", + "members": { + "beginOffsetInclusive": { + "target": "com.amazonaws.qconnect#CitationSpanOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Where the text with a citation starts in the generated output.
" + } + }, + "endOffsetExclusive": { + "target": "com.amazonaws.qconnect#CitationSpanOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Where the text with a citation ends in the generated output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated\n output.
" + } + }, + "com.amazonaws.qconnect#CitationSpanOffset": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.qconnect#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.qconnect#Configuration": { + "type": "union", + "members": { + "connectConfiguration": { + "target": "com.amazonaws.qconnect#ConnectConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information of the Amazon Connect data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information of the external data source.
" + } + }, + "com.amazonaws.qconnect#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the\n resource. For example, if you're using a Create API (such as\n CreateAssistant) that accepts name, a conflicting resource (usually with the\n 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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information of the Amazon Connect data source.
" + } + }, + "com.amazonaws.qconnect#ContactAttributeKey": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributeKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ContactAttributeValue": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "value": { + "target": "com.amazonaws.qconnect#ContactAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Content": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContent" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContent" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateContent" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContent" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContents" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#GetContentSummary" + } + ], + "resources": [ + { + "target": "com.amazonaws.qconnect#ContentAssociation" + } + ], + "traits": { + "aws.api#arn": { + "template": "content/{knowledgeBaseId}/{contentId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentAssociation": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContentAssociation" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContentAssociation" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContentAssociation" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContentAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "content-association/{knowledgeBaseId}/{contentId}/{contentAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentAssociationContents": { + "type": "union", + "members": { + "amazonConnectGuideAssociation": { + "target": "com.amazonaws.qconnect#AmazonConnectGuideAssociationData", + "traits": { + "smithy.api#documentation": "The data of the step-by-step guide association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The contents of a content association.
" + } + }, + "com.amazonaws.qconnect#ContentAssociationData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "The type of association.
", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "The content association.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the content association.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "The type of association.
", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "The content association.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a content association.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentAssociationSummary" + } + }, + "com.amazonaws.qconnect#ContentAssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMAZON_CONNECT_GUIDE", + "name": "AMAZON_CONNECT_GUIDE" + } + ] + } + }, + "com.amazonaws.qconnect#ContentData": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "The name of the content.
", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the content revision.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "The title of the content.
", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "The media type of the content.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "The status of the content.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor 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.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "linkOutUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "The URI of the content.
" + } + }, + "url": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "The URL of the content.
", + "smithy.api#required": {} + } + }, + "urlExpiry": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The expiration time of the URL as an epoch timestamp.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the content.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentDataDetails": { + "type": "structure", + "members": { + "textData": { + "target": "com.amazonaws.qconnect#TextData", + "traits": { + "smithy.api#documentation": "Details about the content text data.
", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "Details about the content ranking data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the content data.
" + } + }, + "com.amazonaws.qconnect#ContentFeedbackData": { + "type": "union", + "members": { + "generativeContentFeedbackData": { + "target": "com.amazonaws.qconnect#GenerativeContentFeedbackData", + "traits": { + "smithy.api#documentation": "Information about the feedback for a generative target type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the feedback.
" + } + }, + "com.amazonaws.qconnect#ContentMetadata": { + "type": "map", "key": { "target": "com.amazonaws.qconnect#NonEmptyString" }, - "value": { - "target": "com.amazonaws.qconnect#NonEmptyString" + "value": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.qconnect#ContentReference": { + "type": "structure", + "members": { + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
" + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
" + } + }, + "sourceURL": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The web URL of the source content.
" + } + }, + "referenceType": { + "target": "com.amazonaws.qconnect#ReferenceType", + "traits": { + "smithy.api#documentation": "The type of reference content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reference information about the content.
" + } + }, + "com.amazonaws.qconnect#ContentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummary": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "The name of the content.
", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the revision of the content.
", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "The title of the content.
", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "The media type of the content.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "The status of the content.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor 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.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about the content.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentSummary" + } + }, + "com.amazonaws.qconnect#ContentTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.qconnect#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + } + }, + "com.amazonaws.qconnect#CreateAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Q in Connect AI Agent.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "The name of the AI Agent.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", + "traits": { + "smithy.api#documentation": "The type of the AI Agent.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agent.
", + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "The visibility status of the AI Agent.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the AI Agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "The data of the created AI Agent.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIAgentVersionResponse" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "Creates and Amazon Q in Connect AI Agent version.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "method": "POST" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#ContentReference": { + "com.amazonaws.qconnect#CreateAIAgentVersionRequest": { "type": "structure", "members": { - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
" + "smithy.api#documentation": "The modification time of the AI Agent should be tracked for version creation. This field\n should be specified to avoid version creation when simultaneous update to the underlying AI\n Agent are possible. The value should be the modifiedTime returned from the request to create\n or update an AI Agent so that version creation can fail if an update to the AI Agent post the\n specified modification time has been made.
" } }, - "contentId": { - "target": "com.amazonaws.qconnect#Uuid", + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", "traits": { - "smithy.api#documentation": "The identifier of the content.
" + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Reference information about the content.
" - } - }, - "com.amazonaws.qconnect#ContentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#ContentSummary": { + "com.amazonaws.qconnect#CreateAIAgentVersionResponse": { "type": "structure", "members": { - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", - "smithy.api#required": {} + "smithy.api#documentation": "The data of the AI Agent version.
" } }, - "contentId": { - "target": "com.amazonaws.qconnect#Uuid", + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", "traits": { - "smithy.api#documentation": "The identifier of the content.
", - "smithy.api#required": {} + "smithy.api#documentation": "The version number of the AI Agent version.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Q in Connect AI Prompt.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} } }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "The name of the content.
", + "smithy.api#documentation": "The name of the AI Prompt.
", "smithy.api#required": {} } }, - "revisionId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "type": { + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "The identifier of the revision of the content.
", + "smithy.api#documentation": "The type of this AI Prompt.
", "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.qconnect#ContentTitle", + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", "traits": { - "smithy.api#documentation": "The title of the content.
", + "smithy.api#documentation": "The configuration of the prompt template for this AI Prompt.
", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.qconnect#ContentType", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "The media type of the content.
", + "smithy.api#documentation": "The visibility status of the AI Prompt.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#ContentStatus", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "The status of the content.
", + "smithy.api#documentation": "The type of the prompt template for this AI Prompt.
", "smithy.api#required": {} } }, - "metadata": { - "target": "com.amazonaws.qconnect#ContentMetadata", + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "A key/value map to store attributes without affecting tagging or recommendations. \nFor 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.
", + "smithy.api#documentation": "The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1\n
The API Format of the AI Prompt.
", "smithy.api#required": {} } }, @@ -1208,39 +2507,124 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the AI Prompt.
" + } } }, "traits": { - "smithy.api#documentation": "Summary information about the content.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#Content" - }, - { - "resource": "com.amazonaws.qconnect#KnowledgeBase" + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptResponse": { + "type": "structure", + "members": { + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", + "traits": { + "smithy.api#documentation": "The data of the AI Prompt.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIPromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIPromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Q in Connect AI Prompt version.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptVersionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the AI Prompt was last modified.
" + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} } - ] - } - }, - "com.amazonaws.qconnect#ContentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#ContentSummary" - } - }, - "com.amazonaws.qconnect#ContentTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#ContentType": { - "type": "string", + "com.amazonaws.qconnect#CreateAIPromptVersionResponse": { + "type": "structure", + "members": { + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", + "traits": { + "smithy.api#documentation": "The data of the AI Prompt version.
" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number of the AI Prompt version.
" + } + } + }, "traits": { - "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + "smithy.api#output": {} } }, "com.amazonaws.qconnect#CreateAssistant": { @@ -1477,7 +2861,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an association between a content resource in a knowledge base and step-by-step\n guides. Step-by-step guides offer instructions to agents for resolving common\n customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step\n guides.
\nAfter you integrate Amazon Q and step-by-step guides, when Amazon Q provides a\n recommendation to an agent based on the intent that it's detected, it also provides them with\n the option to start the step-by-step guide that you have associated with the content.
\nNote the following limitations:
\nYou can create only one content association for each\n content resource in a knowledge base.
\nYou can associate a step-by-step guide with multiple content resources.
\nFor more information, see Integrate Amazon Q in Connect with\n step-by-step guides in the Amazon Connect Administrator\n Guide.
", + "smithy.api#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\n common customer issues. You create a content association to integrate Amazon Q in Connect and\n step-by-step guides.
\nAfter you integrate Amazon Q and step-by-step guides, when Amazon Q provides a\n recommendation to an agent based on the intent that it's detected, it also provides them with\n the option to start the step-by-step guide that you have associated with the content.
\nNote the following limitations:
\nYou can create only one content association for each content resource in a knowledge\n base.
\nYou can associate a step-by-step guide with multiple content resources.
\nFor more information, see Integrate Amazon Q in Connect with\n step-by-step guides in the Amazon Connect Administrator\n Guide.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", "method": "POST" @@ -1685,6 +3069,12 @@ "smithy.api#documentation": "Information about how to render the content.
" } }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { @@ -1917,94 +3307,380 @@ "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, - "tagFilter": { - "target": "com.amazonaws.qconnect#TagFilter", - "traits": { - "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" - } + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" + } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.
" + } + } + } + }, + "com.amazonaws.qconnect#CreateSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData", + "traits": { + "smithy.api#documentation": "The session.
" + } + } + } + }, + "com.amazonaws.qconnect#DataDetails": { + "type": "union", + "members": { + "contentData": { + "target": "com.amazonaws.qconnect#ContentDataDetails", + "traits": { + "smithy.api#documentation": "Details about the content data.
" + } + }, + "generativeData": { + "target": "com.amazonaws.qconnect#GenerativeDataDetails", + "traits": { + "smithy.api#documentation": "Details about the generative data.
" + } + }, + "intentDetectedData": { + "target": "com.amazonaws.qconnect#IntentDetectedDataDetails", + "traits": { + "smithy.api#documentation": "Details about the intent data.
" + } + }, + "sourceContentData": { + "target": "com.amazonaws.qconnect#SourceContentDataDetails", + "traits": { + "smithy.api#documentation": "Details about the content data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the data.
" + } + }, + "com.amazonaws.qconnect#DataReference": { + "type": "union", + "members": { + "contentReference": { + "target": "com.amazonaws.qconnect#ContentReference" + }, + "generativeReference": { + "target": "com.amazonaws.qconnect#GenerativeReference", + "traits": { + "smithy.api#documentation": "Reference information about the generative content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reference data.
" + } + }, + "com.amazonaws.qconnect#DataSummary": { + "type": "structure", + "members": { + "reference": { + "target": "com.amazonaws.qconnect#DataReference", + "traits": { + "smithy.api#documentation": "Reference information about the content.
", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.qconnect#DataDetails", + "traits": { + "smithy.api#documentation": "Details about the data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the data.
" + } + }, + "com.amazonaws.qconnect#DataSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#DataSummary" + } + }, + "com.amazonaws.qconnect#DeleteAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Q in Connect AI Agent.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Q in Connect AI Agent Version.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions/{versionNumber}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number of the AI Agent version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon Q in Connect AI Prompt.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#CreateSessionResponse": { + "com.amazonaws.qconnect#DeleteAIPromptRequest": { "type": "structure", "members": { - "session": { - "target": "com.amazonaws.qconnect#SessionData", - "traits": { - "smithy.api#documentation": "The session.
" - } - } - } - }, - "com.amazonaws.qconnect#DataDetails": { - "type": "union", - "members": { - "contentData": { - "target": "com.amazonaws.qconnect#ContentDataDetails", - "traits": { - "smithy.api#documentation": "Details about the content data.
" - } - }, - "generativeData": { - "target": "com.amazonaws.qconnect#GenerativeDataDetails", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "Details about the generative data.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "sourceContentData": { - "target": "com.amazonaws.qconnect#SourceContentDataDetails", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "Details about the content data.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about the data.
" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#DataReference": { - "type": "union", - "members": { - "contentReference": { - "target": "com.amazonaws.qconnect#ContentReference" + "com.amazonaws.qconnect#DeleteAIPromptResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIPromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "generativeReference": { - "target": "com.amazonaws.qconnect#GenerativeReference", - "traits": { - "smithy.api#documentation": "Reference information about the generative content.
" - } + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } - }, + ], "traits": { - "smithy.api#documentation": "Reference data.
" + "smithy.api#documentation": "Delete and Amazon Q in Connect AI Prompt version.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions/{versionNumber}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#DataSummary": { + "com.amazonaws.qconnect#DeleteAIPromptVersionRequest": { "type": "structure", "members": { - "reference": { - "target": "com.amazonaws.qconnect#DataReference", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "Reference information about the content.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "details": { - "target": "com.amazonaws.qconnect#DataDetails", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "Details about the data.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number of the AI Prompt version to be deleted.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Summary of the data.
" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#DataSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#DataSummary" + "com.amazonaws.qconnect#DeleteAIPromptVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.qconnect#DeleteAssistant": { @@ -2491,6 +4167,12 @@ "smithy.api#documentation": "The configuration information of the external data source.
" } }, + "com.amazonaws.qconnect#FailureReason": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#NonEmptyString" + } + }, "com.amazonaws.qconnect#Filter": { "type": "structure", "members": { @@ -2548,6 +4230,35 @@ ] } }, + "com.amazonaws.qconnect#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the\n chunkingStrategy as NONE, exclude this field.
The feedback information for a generative target type.
" + "smithy.api#documentation": "The feedback information for a generative target type.
" + } + }, + "com.amazonaws.qconnect#GenerativeDataDetails": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "The LLM response.
", + "smithy.api#required": {} + } + }, + "references": { + "target": "com.amazonaws.qconnect#DataSummaryList", + "traits": { + "smithy.api#documentation": "The references used to generative the LLM response.
", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "Details about the generative content ranking data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about generative data.
" + } + }, + "com.amazonaws.qconnect#GenerativeReference": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.qconnect#LlmModelId", + "traits": { + "smithy.api#documentation": "The identifier of the LLM model.
" + } + }, + "generationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the LLM model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Reference information about generative content.
" + } + }, + "com.amazonaws.qconnect#GenericArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + } + }, + "com.amazonaws.qconnect#GetAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets an Amazon Q in Connect AI Agent.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier).\n Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#GetAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "The data of the AI Agent.
" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "The version number of the AI Agent version (returned if an AI Agent version was specified\n via use of a qualifier for the aiAgentId on the request).
Gets and Amazon Q in Connect AI Prompt.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "GET" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.qconnect#GenerativeDataDetails": { + "com.amazonaws.qconnect#GetAIPromptRequest": { "type": "structure", "members": { - "completion": { - "target": "com.amazonaws.qconnect#SensitiveString", - "traits": { - "smithy.api#documentation": "The LLM response.
", - "smithy.api#required": {} - } - }, - "references": { - "target": "com.amazonaws.qconnect#DataSummaryList", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The references used to generative the LLM response.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "rankingData": { - "target": "com.amazonaws.qconnect#RankingData", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "Details about the generative content ranking data.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about generative data.
" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#GenerativeReference": { + "com.amazonaws.qconnect#GetAIPromptResponse": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.qconnect#LlmModelId", + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", "traits": { - "smithy.api#documentation": "The identifier of the LLM model.
" + "smithy.api#documentation": "The data of the AI Prompt.
" } }, - "generationId": { - "target": "com.amazonaws.qconnect#Uuid", + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", "traits": { - "smithy.api#documentation": "The identifier of the LLM model.
" + "smithy.api#documentation": "The version number of the AI Prompt version (returned if an AI Prompt version was\n specified via use of a qualifier for the aiPromptId on the request).
Reference information about generative content.
" - } - }, - "com.amazonaws.qconnect#GenericArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + "smithy.api#output": {} } }, "com.amazonaws.qconnect#GetAssistant": { @@ -3315,6 +5176,62 @@ "target": "com.amazonaws.qconnect#NonEmptyString" } }, + "com.amazonaws.qconnect#HierarchicalChunkingConfiguration": { + "type": "structure", + "members": { + "levelConfigurations": { + "target": "com.amazonaws.qconnect#HierarchicalChunkingLevelConfigurations", + "traits": { + "smithy.api#documentation": "Token settings for each layer.
", + "smithy.api#required": {} + } + }, + "overlapTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking\n splits documents into layers of chunks where the first layer contains large chunks, and the\n second layer contains smaller chunks derived from the first layer.
" + } + }, + "com.amazonaws.qconnect#HierarchicalChunkingLevelConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Token settings for each layer.
" + } + }, + "com.amazonaws.qconnect#HierarchicalChunkingLevelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#HierarchicalChunkingLevelConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, "com.amazonaws.qconnect#Highlight": { "type": "structure", "members": { @@ -3571,6 +5488,43 @@ ] } }, + "com.amazonaws.qconnect#IntentDetectedDataDetails": { + "type": "structure", + "members": { + "intent": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "The detected intent.
", + "smithy.api#required": {} + } + }, + "intentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the detected intent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the detected intent.
" + } + }, + "com.amazonaws.qconnect#IntentInputData": { + "type": "structure", + "members": { + "intentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q intent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Amazon Q intent.
" + } + }, "com.amazonaws.qconnect#KnowledgeBase": { "type": "resource", "identifiers": { @@ -3635,6 +5589,29 @@ "aws.iam#disableConditionKeyInference": {} } }, + "com.amazonaws.qconnect#KnowledgeBaseAssociationConfigurationData": { + "type": "structure", + "members": { + "contentTagFilter": { + "target": "com.amazonaws.qconnect#TagFilter" + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "overrideKnowledgeBaseSearchType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSearchType", + "traits": { + "smithy.api#documentation": "The search type to be used against the Knowledge Base for this request. The values can be\n SEMANTIC which uses vector embeddings or HYBRID which use vector\n embeddings and raw text
The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect\n Assistant Association.
The Amazon Resource Name (ARN) of the knowledge base.
" } - } - }, + } + }, + "traits": { + "smithy.api#documentation": "Association information about the knowledge base.
" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "The type of knowledge base.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base.
", + "smithy.api#required": {} + } + }, + "lastContentModificationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.
", + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", + "traits": { + "smithy.api#documentation": "Source configuration information about the knowledge base.
" + } + }, + "renderingConfiguration": { + "target": "com.amazonaws.qconnect#RenderingConfiguration", + "traits": { + "smithy.api#documentation": "Information about how to render the content.
" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n 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\n your instance.
" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description.
" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + }, + "ingestionStatus": { + "target": "com.amazonaws.qconnect#SyncStatus", + "traits": { + "smithy.api#documentation": "Status of ingestion on data source.
" + } + }, + "ingestionFailureReasons": { + "target": "com.amazonaws.qconnect#FailureReason", + "traits": { + "smithy.api#documentation": "List of failure reasons on ingestion per file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the knowledge base.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSummary" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseSearchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HYBRID", + "name": "HYBRID" + }, + { + "value": "SEMANTIC", + "name": "SEMANTIC" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseStatus": { + "type": "string", "traits": { - "smithy.api#documentation": "Association information about the knowledge base.
" + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] } }, - "com.amazonaws.qconnect#KnowledgeBaseData": { + "com.amazonaws.qconnect#KnowledgeBaseSummary": { "type": "structure", "members": { "knowledgeBaseId": { @@ -3689,21 +5821,20 @@ "status": { "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", "traits": { - "smithy.api#documentation": "The status of the knowledge base.
", + "smithy.api#documentation": "The status of the knowledge base summary.
", "smithy.api#required": {} } }, - "lastContentModificationTime": { - "target": "smithy.api#Timestamp", + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", "traits": { - "smithy.api#documentation": "An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.
", - "smithy.api#timestampFormat": "epoch-seconds" + "smithy.api#documentation": "Configuration information about the external data source.
" } }, - "sourceConfiguration": { - "target": "com.amazonaws.qconnect#SourceConfiguration", + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", "traits": { - "smithy.api#documentation": "Source configuration information about the knowledge base.
" + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" } }, "renderingConfiguration": { @@ -3721,7 +5852,7 @@ "description": { "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "The description.
" + "smithy.api#documentation": "The description of the knowledge base.
" } }, "tags": { @@ -3732,7 +5863,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the knowledge base.
", + "smithy.api#documentation": "Summary information about the knowledge base.
", "smithy.api#references": [ { "resource": "com.amazonaws.qconnect#KnowledgeBase" @@ -3740,147 +5871,436 @@ ] } }, - "com.amazonaws.qconnect#KnowledgeBaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#KnowledgeBaseSummary" - } - }, - "com.amazonaws.qconnect#KnowledgeBaseStatus": { + "com.amazonaws.qconnect#KnowledgeBaseType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" + "value": "EXTERNAL", + "name": "EXTERNAL" }, { - "value": "ACTIVE", - "name": "ACTIVE" + "value": "CUSTOM", + "name": "CUSTOM" }, { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" }, { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "value": "MESSAGE_TEMPLATES", + "name": "MESSAGE_TEMPLATES" }, { - "value": "DELETED", - "name": "DELETED" + "value": "MANAGED", + "name": "MANAGED" } ] } }, - "com.amazonaws.qconnect#KnowledgeBaseSummary": { + "com.amazonaws.qconnect#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 5 + } + } + }, + "com.amazonaws.qconnect#ListAIAgentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIAgentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIAgentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List AI Agent versions.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiAgentVersionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentVersionsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent for which versions are to be\n listed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "The origin of the AI Agent versions to be listed. SYSTEM for a default AI\n Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI\n Agent creation APIs.
The summaries of AI Agent versions.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIAgents": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIAgentsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIAgentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists AI Agents.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiAgentSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "The origin of the AI Agents to be listed. SYSTEM for a default AI Agent\n created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent\n creation APIs.
The summaries of AI Agents.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIPromptVersionsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIPromptVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists AI Prompt versions.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiPromptVersionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptVersionsRequest": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI prompt for which versions are to be\n listed.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.qconnect#Name", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "The name of the knowledge base.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" } }, - "knowledgeBaseType": { - "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", "traits": { - "smithy.api#documentation": "The type of knowledge base.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" } }, - "status": { - "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "The status of the knowledge base summary.
", + "smithy.api#documentation": "The origin of the AI Prompt versions to be listed. SYSTEM for a default AI\n Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI\n Agent creation APIs.
The summaries of the AI Prompt versions.
", "smithy.api#required": {} } }, - "sourceConfiguration": { - "target": "com.amazonaws.qconnect#SourceConfiguration", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "Configuration information about the external data source.
" + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIPromptsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIPromptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "renderingConfiguration": { - "target": "com.amazonaws.qconnect#RenderingConfiguration", + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the AI Prompts available on the Amazon Q in Connect assistant.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiPromptSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "Information about how to render the content.
" + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThis KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n 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\n your instance.
" + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" } }, - "description": { - "target": "com.amazonaws.qconnect#Description", + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", "traits": { - "smithy.api#documentation": "The description of the knowledge base.
" + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + "smithy.api#documentation": "The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent\n created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent\n creation APIs.
Summary information about the knowledge base.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#KnowledgeBase" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#KnowledgeBaseType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EXTERNAL", - "name": "EXTERNAL" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" - }, - { - "value": "QUICK_RESPONSES", - "name": "QUICK_RESPONSES" + "com.amazonaws.qconnect#ListAIPromptsResponse": { + "type": "structure", + "members": { + "aiPromptSummaries": { + "target": "com.amazonaws.qconnect#AIPromptSummaryList", + "traits": { + "smithy.api#documentation": "The summaries of the AI Prompts.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" } - ] - } - }, - "com.amazonaws.qconnect#LanguageCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 5 } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.qconnect#ListAssistantAssociations": { @@ -4492,6 +6912,40 @@ } } }, + "com.amazonaws.qconnect#ManagedSourceConfiguration": { + "type": "union", + "members": { + "webCrawlerConfiguration": { + "target": "com.amazonaws.qconnect#WebCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "Configuration data for web crawler data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Source configuration for managed resources.
" + } + }, + "com.amazonaws.qconnect#ManualSearchAIAgentConfiguration": { + "type": "structure", + "members": { + "answerGenerationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI\n Agent.
" + } + }, + "associationConfigurations": { + "target": "com.amazonaws.qconnect#AssociationConfigurationList", + "traits": { + "smithy.api#documentation": "The association configurations for overriding behavior on this AI Agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for the MANUAL_SEARCH AI Agent type.
A list of conditions which would be applied together with an OR\n condition.
A list of conditions which would be applied together with an OR\n condition.
The parsing strategy for the data source.
", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.qconnect#BedrockFoundationModelConfigurationForParsing", + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for parsing document contents. By default, the service converts the contents of\n each document into text before splitting it into chunks. To improve processing of PDF files\n with tables and images, you can configure the data source to convert the pages of text into\n images and use a model to describe the contents of each page.
" + } + }, + "com.amazonaws.qconnect#ParsingPrompt": { + "type": "structure", + "members": { + "parsingPromptText": { + "target": "com.amazonaws.qconnect#ParsingPromptText", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" } }, - "com.amazonaws.qconnect#OrConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#OrCondition" + "com.amazonaws.qconnect#ParsingPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } } }, - "com.amazonaws.qconnect#Order": { + "com.amazonaws.qconnect#ParsingStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "ASC", - "name": "ASC" - }, - { - "value": "DESC", - "name": "DESC" + "value": "BEDROCK_FOUNDATION_MODEL", + "name": "BEDROCK_FOUNDATION_MODEL" } ] } @@ -4881,8 +7416,7 @@ "queryText": { "target": "com.amazonaws.qconnect#QueryText", "traits": { - "smithy.api#documentation": "The text to search for.
", - "smithy.api#required": {} + "smithy.api#documentation": "The text to search for.
" } }, "nextToken": { @@ -4908,6 +7442,18 @@ "traits": { "smithy.api#documentation": "Information about how to query content.
" } + }, + "queryInputData": { + "target": "com.amazonaws.qconnect#QueryInputData", + "traits": { + "smithy.api#documentation": "Information about the query.
" + } + }, + "overrideKnowledgeBaseSearchType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSearchType", + "traits": { + "smithy.api#documentation": "The search type to be used against the Knowledge Base for this request. The values can be\n SEMANTIC which uses vector embeddings or HYBRID which use vector\n embeddings and raw text.
The condition for the query.
" } }, + "com.amazonaws.qconnect#QueryInputData": { + "type": "union", + "members": { + "queryTextInputData": { + "target": "com.amazonaws.qconnect#QueryTextInputData", + "traits": { + "smithy.api#documentation": "Input information for the query.
" + } + }, + "intentInputData": { + "target": "com.amazonaws.qconnect#IntentInputData", + "traits": { + "smithy.api#documentation": "Input information for the intent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input information for the query.
" + } + }, "com.amazonaws.qconnect#QueryRecommendationTriggerData": { "type": "structure", "members": { @@ -5028,6 +7594,10 @@ "value": "KNOWLEDGE_CONTENT", "name": "KNOWLEDGE_CONTENT" }, + { + "value": "INTENT_ANSWER", + "name": "INTENT_ANSWER" + }, { "value": "GENERATIVE_ANSWER", "name": "GENERATIVE_ANSWER" @@ -5045,11 +7615,26 @@ "type": "string", "traits": { "smithy.api#length": { - "max": 1024 + "max": 512 }, "smithy.api#sensitive": {} } }, + "com.amazonaws.qconnect#QueryTextInputData": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#QueryText", + "traits": { + "smithy.api#documentation": "The text to search for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the text to search for.
" + } + }, "com.amazonaws.qconnect#QuickResponse": { "type": "resource", "identifiers": { @@ -6030,6 +8615,25 @@ { "value": "GENERATIVE_ANSWER", "name": "GENERATIVE_ANSWER" + }, + { + "value": "DETECTED_INTENT", + "name": "DETECTED_INTENT" + } + ] + } + }, + "com.amazonaws.qconnect#ReferenceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WEB_CRAWLER", + "name": "WEB_CRAWLER" + }, + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" } ] } @@ -6077,6 +8681,69 @@ } } }, + "com.amazonaws.qconnect#RemoveAssistantAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect\n Assistant.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagentConfiguration", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#RemoveAssistantAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentType": { + "target": "com.amazonaws.qconnect#AIAgentType", + "traits": { + "smithy.api#documentation": "The type of the AI Agent being removed for use by default from the Amazon Q in Connect\n Assistant.
", + "smithy.api#httpQuery": "aiAgentType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#RemoveAssistantAIAgentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUri": { "type": "operation", "input": { @@ -6209,6 +8876,54 @@ "smithy.api#documentation": "Information about the result.
" } }, + "com.amazonaws.qconnect#RuntimeSessionData": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qconnect#NonEmptySensitiveString", + "traits": { + "smithy.api#documentation": "The key of the data stored on the session.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataValue", + "traits": { + "smithy.api#documentation": "The value of the data stored on the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The list of key-value pairs that are stored on the session.
" + } + }, + "com.amazonaws.qconnect#RuntimeSessionDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#RuntimeSessionData" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.qconnect#RuntimeSessionDataValue": { + "type": "union", + "members": { + "stringValue": { + "target": "com.amazonaws.qconnect#NonEmptySensitiveString", + "traits": { + "smithy.api#documentation": "The string value of the data stored on the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A union type that specifies the data stored on the session.
" + } + }, "com.amazonaws.qconnect#SearchContent": { "type": "operation", "input": { @@ -6497,6 +9212,72 @@ } } }, + "com.amazonaws.qconnect#SeedUrl": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.qconnect#WebUrl", + "traits": { + "smithy.api#documentation": "URL for crawling
" + } + } + }, + "traits": { + "smithy.api#documentation": "A URL for crawling.
" + } + }, + "com.amazonaws.qconnect#SeedUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qconnect#SemanticChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "bufferSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The buffer size.
", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", + "smithy.api#range": { + "min": 50, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits a\n document into smaller documents based on groups of similar content derived from the text with\n natural language processing.
" + } + }, "com.amazonaws.qconnect#SensitiveString": { "type": "string", "traits": { @@ -6549,6 +9330,11 @@ "update": { "target": "com.amazonaws.qconnect#UpdateSession" }, + "operations": [ + { + "target": "com.amazonaws.qconnect#UpdateSessionData" + } + ], "traits": { "aws.api#arn": { "template": "session/{assistantId}/{sessionId}" @@ -6603,12 +9389,29 @@ "traits": { "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.
" + } } }, "traits": { "smithy.api#documentation": "Information about the session.
" } }, + "com.amazonaws.qconnect#SessionDataNamespace": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Custom", + "name": "Custom" + } + ] + } + }, "com.amazonaws.qconnect#SessionIntegrationConfiguration": { "type": "structure", "members": { @@ -6682,6 +9485,12 @@ "traits": { "smithy.api#documentation": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" } + }, + "managedSourceConfiguration": { + "target": "com.amazonaws.qconnect#ManagedSourceConfiguration", + "traits": { + "smithy.api#documentation": "Source configuration for managed resources.
" + } } }, "traits": { @@ -6718,6 +9527,12 @@ "smithy.api#documentation": "Details about the source content ranking data.
", "smithy.api#required": {} } + }, + "citationSpan": { + "target": "com.amazonaws.qconnect#CitationSpan", + "traits": { + "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
" + } } }, "traits": { @@ -6899,24 +9714,78 @@ "traits": { "smithy.api#documentation": "The configuration information of the external source that the resource data are imported\n from.
" } - } - }, - "traits": { - "smithy.api#input": {} + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#StartImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.qconnect#ImportJobData", + "traits": { + "smithy.api#documentation": "The import job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] } }, - "com.amazonaws.qconnect#StartImportJobResponse": { - "type": "structure", - "members": { - "importJob": { - "target": "com.amazonaws.qconnect#ImportJobData", - "traits": { - "smithy.api#documentation": "The import job.
" - } - } - }, + "com.amazonaws.qconnect#SyncStatus": { + "type": "string", "traits": { - "smithy.api#output": {} + "smithy.api#enum": [ + { + "value": "SYNC_FAILED", + "name": "SYNC_FAILED" + }, + { + "value": "SYNCING_IN_PROGRESS", + "name": "SYNCING_IN_PROGRESS" + }, + { + "value": "SYNC_SUCCESS", + "name": "SYNC_SUCCESS" + }, + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + } + ] } }, "com.amazonaws.qconnect#TagCondition": { @@ -7070,6 +9939,16 @@ ] } }, + "com.amazonaws.qconnect#TextAIPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qconnect#TextData": { "type": "structure", "members": { @@ -7084,6 +9963,21 @@ "smithy.api#documentation": "Details about the source content text data.
" } }, + "com.amazonaws.qconnect#TextFullAIPromptEditTemplateConfiguration": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#TextAIPrompt", + "traits": { + "smithy.api#documentation": "The YAML text for the AI Prompt template.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a prompt template that supports full textual prompt configuration\n using a YAML prompt.
" + } + }, "com.amazonaws.qconnect#ThrottlingException": { "type": "structure", "members": { @@ -7108,71 +10002,338 @@ } } }, - "com.amazonaws.qconnect#TooManyTagsException": { + "com.amazonaws.qconnect#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The specified resource name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Q in Connect throws this exception if you have too many tags in your tag set.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qconnect#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified tags from the specified resource.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.qconnect#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#UpdateAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an AI Agent.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UpdateAIAgentRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "The visbility status of the Amazon Q in Connect AI Agent.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Amazon Q in Connect AI Agent.
" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the Amazon Q in Connect AI Agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "The data of the updated Amazon Q in Connect AI Agent.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an AI Prompt.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPromptRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect AI Prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "The visibility status of the Amazon Q in Connect AI prompt.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the prompt template for this AI Prompt.
" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "The description of the Amazon Q in Connect AI Prompt.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPromptResponse": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String" - }, - "resourceName": { - "target": "smithy.api#String", + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", "traits": { - "smithy.api#documentation": "The specified resource name.
" + "smithy.api#documentation": "The data of the updated Amazon Q in Connect AI Prompt.
" } } }, "traits": { - "smithy.api#documentation": "Amazon Q in Connect throws this exception if you have too many tags in your tag set.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#output": {} } }, - "com.amazonaws.qconnect#UntagResource": { + "com.amazonaws.qconnect#UpdateAssistantAIAgent": { "type": "operation", "input": { - "target": "com.amazonaws.qconnect#UntagResourceRequest" + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgentRequest" }, "output": { - "target": "com.amazonaws.qconnect#UntagResourceResponse" + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgentResponse" }, "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, { "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } ], "traits": { - "smithy.api#documentation": "Removes the specified tags from the specified resource.
", + "smithy.api#documentation": "Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect\n Assistant.
", "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "DELETE" - }, - "smithy.api#idempotent": {} + "uri": "/assistants/{assistantId}/aiagentConfiguration", + "method": "POST" + } } }, - "com.amazonaws.qconnect#UntagResourceRequest": { + "com.amazonaws.qconnect#UpdateAssistantAIAgentRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.qconnect#Arn", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.qconnect#TagKeyList", + "aiAgentType": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "The tag keys.
", - "smithy.api#httpQuery": "tagKeys", + "smithy.api#documentation": "The type of the AI Agent being updated for use by default on the Amazon Q in Connect\n Assistant.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationData", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agent being updated for use by default on the Amazon Q in\n Connect Assistant.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#UntagResourceResponse": { + "com.amazonaws.qconnect#UpdateAssistantAIAgentResponse": { "type": "structure", - "members": {} + "members": { + "assistant": { + "target": "com.amazonaws.qconnect#AssistantData" + } + }, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.qconnect#UpdateContent": { "type": "operation", @@ -7500,6 +10661,106 @@ } } }, + "com.amazonaws.qconnect#UpdateSessionData": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateSessionDataRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateSessionDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the data stored on an Amazon Q in Connect Session.
", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}/data", + "method": "PATCH" + } + } + }, + "com.amazonaws.qconnect#UpdateSessionDataRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the\n ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.qconnect#SessionDataNamespace", + "traits": { + "smithy.api#documentation": "The namespace into which the session data is stored. Supported namespaces are:\n Custom
" + } + }, + "data": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataList", + "traits": { + "smithy.api#documentation": "The data stored on the Amazon Q in Connect Session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateSessionDataResponse": { + "type": "structure", + "members": { + "sessionArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the session.
", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.qconnect#SessionDataNamespace", + "traits": { + "smithy.api#documentation": "The namespace into which the session data is stored. Supported namespaces are:\n Custom
", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataList", + "traits": { + "smithy.api#documentation": "Data stored in the session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#UpdateSessionRequest": { "type": "structure", "members": { @@ -7530,6 +10791,12 @@ "traits": { "smithy.api#documentation": "An object that can be used to specify Tag conditions.
" } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.
" + } } }, "traits": { @@ -7575,6 +10842,43 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.qconnect#UrlConfiguration": { + "type": "structure", + "members": { + "seedUrls": { + "target": "com.amazonaws.qconnect#SeedUrls", + "traits": { + "smithy.api#documentation": "List of URLs for crawling.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want to crawl. You should\n be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.qconnect#UrlFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#UrlFilterPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#UrlFilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qconnect#Uuid": { "type": "string", "traits": { @@ -7587,6 +10891,18 @@ "smithy.api#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}$" } }, + "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier": { + "type": "string", + "traits": { + "smithy.api#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}$" + } + }, + "com.amazonaws.qconnect#UuidWithQualifier": { + "type": "string", + "traits": { + "smithy.api#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}$" + } + }, "com.amazonaws.qconnect#ValidationException": { "type": "structure", "members": { @@ -7600,6 +10916,49 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.qconnect#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.qconnect#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt\n from a data source that is returned when the knowledge base that it belongs to is\n queried.
" + } + }, + "parsingConfiguration": { + "target": "com.amazonaws.qconnect#ParsingConfiguration", + "traits": { + "smithy.api#documentation": "A custom parser for data source documents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, + "com.amazonaws.qconnect#Version": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.qconnect#VisibilityStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SAVED", + "name": "SAVED" + }, + { + "value": "PUBLISHED", + "name": "PUBLISHED" + } + ] + } + }, "com.amazonaws.qconnect#WaitTimeSeconds": { "type": "integer", "traits": { @@ -7610,6 +10969,84 @@ } } }, + "com.amazonaws.qconnect#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "urlConfiguration": { + "target": "com.amazonaws.qconnect#UrlConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want to crawl. You should\n be authorized to crawl the URLs.
", + "smithy.api#required": {} + } + }, + "crawlerLimits": { + "target": "com.amazonaws.qconnect#WebCrawlerLimits", + "traits": { + "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" + } + }, + "inclusionFilters": { + "target": "com.amazonaws.qconnect#UrlFilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain URLs. If\n you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion\n filter takes precedence and the web content of the URL isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.qconnect#UrlFilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain URLs. If\n you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion\n filter takes precedence and the web content of the URL isn’t crawled.
" + } + }, + "scope": { + "target": "com.amazonaws.qconnect#WebScopeType", + "traits": { + "smithy.api#documentation": "The scope of what is crawled for your URLs. You can choose to crawl only web pages that\n belong to the same host or primary domain. For example, only web pages that contain the seed\n URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains.\n You can choose to include sub domains in addition to the host or primary domain. For example,\n web pages that contain aws.amazon.com can also include sub domain\n docs.aws.amazon.com.
The configuration details for the web data source.
" + } + }, + "com.amazonaws.qconnect#WebCrawlerLimits": { + "type": "structure", + "members": { + "rateLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Rate of web URLs retrieved per minute.
", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" + } + }, + "com.amazonaws.qconnect#WebScopeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HOST_ONLY", + "name": "HOST_ONLY" + }, + { + "value": "SUBDOMAINS", + "name": "SUBDOMAINS" + } + ] + } + }, + "com.amazonaws.qconnect#WebUrl": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, "com.amazonaws.qconnect#WisdomService": { "type": "service", "version": "2020-10-19", @@ -7643,7 +11080,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).
\nAmazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.
\nAmazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.
\nUse the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.
\nFor more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.
", + "smithy.api#documentation": "\n Amazon Q\n actions\n
\n\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).
\nAmazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.
\nAmazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.
\nUse the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.
\nFor more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.
", "smithy.api#title": "Amazon Q Connect", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/redshift.json b/codegen/sdk-codegen/aws-models/redshift.json index 3c33c7abb7a..7779fb3ef89 100644 --- a/codegen/sdk-codegen/aws-models/redshift.json +++ b/codegen/sdk-codegen/aws-models/redshift.json @@ -8506,9 +8506,9 @@ } }, "S3KeyPrefix": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#S3KeyPrefixValue", "traits": { - "smithy.api#documentation": "The prefix applied to the log file names.
\nConstraints:
\nCannot exceed 512 characters
\nCannot contain spaces( ), double quotes (\"), single quotes ('), a backslash\n (\\), or control characters. The hexadecimal codes for invalid characters are:
\nx00 to x20
\nx22
\nx27
\nx5c
\nx7f or larger
\nThe prefix applied to the log file names.
\nValid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: \n underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (\\),\n hyphen (-), at symbol (@).
The prefix applied to the log file names.
" } @@ -16912,6 +16912,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#S3KeyPrefixValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, "com.amazonaws.redshift#SNSInvalidTopicFault": { "type": "structure", "members": {