{ "smithy": "2.0", "shapes": { "com.amazonaws.wisdom#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.wisdom#AppIntegrationsConfiguration": { "type": "structure", "members": { "appIntegrationArn": { "target": "com.amazonaws.wisdom#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\n DataIntegration must be null. The SourceURI of your\n 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 s3:GetBucketLocation\n against the bucket.
The fields from the source that are made available to your agents in Wisdom. 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.wisdom#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})?$" } }, "com.amazonaws.wisdom#Assistant": { "type": "resource", "identifiers": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateAssistant" }, "read": { "target": "com.amazonaws.wisdom#GetAssistant" }, "delete": { "target": "com.amazonaws.wisdom#DeleteAssistant" }, "list": { "target": "com.amazonaws.wisdom#ListAssistants" }, "operations": [ { "target": "com.amazonaws.wisdom#GetRecommendations" }, { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceived" }, { "target": "com.amazonaws.wisdom#QueryAssistant" }, { "target": "com.amazonaws.wisdom#SearchSessions" } ], "resources": [ { "target": "com.amazonaws.wisdom#AssistantAssociation" }, { "target": "com.amazonaws.wisdom#Session" } ], "traits": { "aws.api#arn": { "template": "assistant/{assistantId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#AssistantAssociation": { "type": "resource", "identifiers": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn" }, "assistantAssociationId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateAssistantAssociation" }, "read": { "target": "com.amazonaws.wisdom#GetAssistantAssociation" }, "delete": { "target": "com.amazonaws.wisdom#DeleteAssistantAssociation" }, "list": { "target": "com.amazonaws.wisdom#ListAssistantAssociations" }, "traits": { "aws.api#arn": { "template": "association/{assistantId}/{assistantAssociationId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#AssistantAssociationData": { "type": "structure", "members": { "assistantAssociationId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the assistant association.
", "smithy.api#required": {} } }, "assistantAssociationArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", "smithy.api#required": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Wisdom assistant.
", "smithy.api#required": {} } }, "associationType": { "target": "com.amazonaws.wisdom#AssociationType", "traits": { "smithy.api#documentation": "The type of association.
", "smithy.api#required": {} } }, "associationData": { "target": "com.amazonaws.wisdom#AssistantAssociationOutputData", "traits": { "smithy.api#documentation": "A union type that currently has a single argument, the knowledge base ID.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "Information about the assistant association.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#AssistantAssociation" } ] } }, "com.amazonaws.wisdom#AssistantAssociationInputData": { "type": "union", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
" } } }, "traits": { "smithy.api#documentation": "The data that is input into Wisdom as a result of the assistant association.
" } }, "com.amazonaws.wisdom#AssistantAssociationOutputData": { "type": "union", "members": { "knowledgeBaseAssociation": { "target": "com.amazonaws.wisdom#KnowledgeBaseAssociationData", "traits": { "smithy.api#documentation": "The knowledge base where output data is sent.
" } } }, "traits": { "smithy.api#documentation": "The data that is output as a result of the assistant association.
" } }, "com.amazonaws.wisdom#AssistantAssociationSummary": { "type": "structure", "members": { "assistantAssociationId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the assistant association.
", "smithy.api#required": {} } }, "assistantAssociationArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assistant association.
", "smithy.api#required": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Wisdom assistant.
", "smithy.api#required": {} } }, "associationType": { "target": "com.amazonaws.wisdom#AssociationType", "traits": { "smithy.api#documentation": "The type of association.
", "smithy.api#required": {} } }, "associationData": { "target": "com.amazonaws.wisdom#AssistantAssociationOutputData", "traits": { "smithy.api#documentation": "The association data.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.wisdom#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 association.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#AssistantAssociation" } ] } }, "com.amazonaws.wisdom#AssistantAssociationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#AssistantAssociationSummary" } }, "com.amazonaws.wisdom#AssistantData": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Wisdom assistant.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wisdom#AssistantType", "traits": { "smithy.api#documentation": "The type of assistant.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#AssistantStatus", "traits": { "smithy.api#documentation": "The status of the assistant.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#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, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey \n permissions to the connect.amazonaws.com service\n principal.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } }, "integrationConfiguration": { "target": "com.amazonaws.wisdom#AssistantIntegrationConfiguration", "traits": { "smithy.api#documentation": "The configuration information for the Wisdom assistant integration.
" } } }, "traits": { "smithy.api#documentation": "The assistant data.
" } }, "com.amazonaws.wisdom#AssistantIntegrationConfiguration": { "type": "structure", "members": { "topicIntegrationArn": { "target": "com.amazonaws.wisdom#GenericArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } } }, "traits": { "smithy.api#documentation": "The configuration information for the Wisdom assistant integration.
" } }, "com.amazonaws.wisdom#AssistantList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#AssistantSummary" } }, "com.amazonaws.wisdom#AssistantStatus": { "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.wisdom#AssistantSummary": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Wisdom assistant.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the assistant.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wisdom#AssistantType", "traits": { "smithy.api#documentation": "The type of the assistant.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#AssistantStatus", "traits": { "smithy.api#documentation": "The status of the assistant.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description of the assistant.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#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, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } }, "integrationConfiguration": { "target": "com.amazonaws.wisdom#AssistantIntegrationConfiguration", "traits": { "smithy.api#documentation": "The configuration information for the Wisdom assistant integration.
" } } }, "traits": { "smithy.api#documentation": "Summary information about the assistant.
" } }, "com.amazonaws.wisdom#AssistantType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AGENT", "name": "AGENT" } ] } }, "com.amazonaws.wisdom#AssociationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "KNOWLEDGE_BASE", "name": "KNOWLEDGE_BASE" } ] } }, "com.amazonaws.wisdom#Channel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#Channels": { "type": "list", "member": { "target": "com.amazonaws.wisdom#Channel" }, "traits": { "smithy.api#uniqueItems": {} } }, "com.amazonaws.wisdom#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.wisdom#Configuration": { "type": "union", "members": { "connectConfiguration": { "target": "com.amazonaws.wisdom#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.wisdom#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.wisdom#ContactAttributeKey": { "type": "string" }, "com.amazonaws.wisdom#ContactAttributeKeys": { "type": "list", "member": { "target": "com.amazonaws.wisdom#ContactAttributeKey" }, "traits": { "smithy.api#sensitive": {}, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wisdom#ContactAttributeValue": { "type": "string" }, "com.amazonaws.wisdom#ContactAttributes": { "type": "map", "key": { "target": "com.amazonaws.wisdom#ContactAttributeKey" }, "value": { "target": "com.amazonaws.wisdom#ContactAttributeValue" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#Content": { "type": "resource", "identifiers": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn" }, "contentId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateContent" }, "read": { "target": "com.amazonaws.wisdom#GetContent" }, "update": { "target": "com.amazonaws.wisdom#UpdateContent" }, "delete": { "target": "com.amazonaws.wisdom#DeleteContent" }, "list": { "target": "com.amazonaws.wisdom#ListContents" }, "operations": [ { "target": "com.amazonaws.wisdom#GetContentSummary" } ], "traits": { "aws.api#arn": { "template": "content/{knowledgeBaseId}/{contentId}" }, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#ContentData": { "type": "structure", "members": { "contentArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", "smithy.api#required": {} } }, "contentId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the content.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the content.
", "smithy.api#required": {} } }, "revisionId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The identifier of the content revision.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wisdom#ContentTitle", "traits": { "smithy.api#documentation": "The title of the content.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#ContentType", "traits": { "smithy.api#documentation": "The media type of the content.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#ContentStatus", "traits": { "smithy.api#documentation": "The status of the content.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.wisdom#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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, "linkOutUri": { "target": "com.amazonaws.wisdom#Uri", "traits": { "smithy.api#documentation": "The URI of the content.
" } }, "url": { "target": "com.amazonaws.wisdom#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.wisdom#Content" }, { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#ContentMetadata": { "type": "map", "key": { "target": "com.amazonaws.wisdom#NonEmptyString" }, "value": { "target": "com.amazonaws.wisdom#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.wisdom#ContentReference": { "type": "structure", "members": { "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
" } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
" } }, "contentArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
" } }, "contentId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the content.
" } } }, "traits": { "smithy.api#documentation": "Reference information about the content.
" } }, "com.amazonaws.wisdom#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.wisdom#ContentSummary": { "type": "structure", "members": { "contentArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", "smithy.api#required": {} } }, "contentId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the content.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the content.
", "smithy.api#required": {} } }, "revisionId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The identifier of the revision of the content.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wisdom#ContentTitle", "traits": { "smithy.api#documentation": "The title of the content.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#ContentType", "traits": { "smithy.api#documentation": "The media type of the content.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#ContentStatus", "traits": { "smithy.api#documentation": "The status of the content.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.wisdom#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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.wisdom#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.wisdom#Content" }, { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#ContentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#ContentSummary" } }, "com.amazonaws.wisdom#ContentTitle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.wisdom#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.wisdom#CreateAssistant": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateAssistantRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateAssistantResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Connect Wisdom assistant.
", "smithy.api#http": { "uri": "/assistants", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#CreateAssistantAssociation": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateAssistantAssociationRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateAssistantAssociationResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the\n only supported association is with a knowledge base. An assistant can have only a single\n association.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/associations", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#CreateAssistantAssociationRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "associationType": { "target": "com.amazonaws.wisdom#AssociationType", "traits": { "smithy.api#documentation": "The type of association.
", "smithy.api#required": {} } }, "association": { "target": "com.amazonaws.wisdom#AssistantAssociationInputData", "traits": { "smithy.api#documentation": "The identifier of the associated resource.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.wisdom#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 Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.wisdom#CreateAssistantAssociationResponse": { "type": "structure", "members": { "assistantAssociation": { "target": "com.amazonaws.wisdom#AssistantAssociationData", "traits": { "smithy.api#documentation": "The assistant association.
" } } } }, "com.amazonaws.wisdom#CreateAssistantRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.wisdom#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 Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the assistant.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wisdom#AssistantType", "traits": { "smithy.api#documentation": "The type of assistant.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description of the assistant.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#ServerSideEncryptionConfiguration", "traits": { "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
\nThe customer managed key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom. To use Wisdom 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 Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } } } }, "com.amazonaws.wisdom#CreateAssistantResponse": { "type": "structure", "members": { "assistant": { "target": "com.amazonaws.wisdom#AssistantData", "traits": { "smithy.api#documentation": "Information about the assistant.
" } } } }, "com.amazonaws.wisdom#CreateContent": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateContentRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateContentResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates Wisdom content. Before to calling this API, use StartContentUpload to\n upload an asset.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#CreateContentRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the content. Each piece of content in a knowledge base must have a unique\n name. You can retrieve a piece of content using only its knowledge base and its name with the\n SearchContent API.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wisdom#ContentTitle", "traits": { "smithy.api#documentation": "The title of the content. If not set, the title is equal to the name.
" } }, "overrideLinkOutUri": { "target": "com.amazonaws.wisdom#Uri", "traits": { "smithy.api#documentation": "The URI you want to use for the article. If the knowledge base has a templateUri, setting\n this argument overrides it for this piece of content.
" } }, "metadata": { "target": "com.amazonaws.wisdom#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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" } }, "uploadId": { "target": "com.amazonaws.wisdom#UploadId", "traits": { "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.wisdom#CreateContentResponse": { "type": "structure", "members": { "content": { "target": "com.amazonaws.wisdom#ContentData", "traits": { "smithy.api#documentation": "The content.
" } } } }, "com.amazonaws.wisdom#CreateKnowledgeBase": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateKnowledgeBaseRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateKnowledgeBaseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a knowledge base.
\nWhen using this API, you cannot reuse Amazon AppIntegrations\n DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,\n you'll get an InvalidRequestException error.
For example, you're programmatically managing your external knowledge base, and you want\n to add or remove one of the fields that is being ingested from Salesforce. Do the\n following:
\nCall DeleteKnowledgeBase.
\nCall DeleteDataIntegration.
\nCall CreateDataIntegration to recreate the DataIntegration or a create different\n one.
\nCall CreateKnowledgeBase.
\nA unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseType": { "target": "com.amazonaws.wisdom#KnowledgeBaseType", "traits": { "smithy.api#documentation": "The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.\n EXTERNAL knowledge bases support integrations with third-party systems whose content is\n synchronized automatically.
", "smithy.api#required": {} } }, "sourceConfiguration": { "target": "com.amazonaws.wisdom#SourceConfiguration", "traits": { "smithy.api#documentation": "The source of the knowledge base content. Only set this argument for EXTERNAL knowledge\n bases.
" } }, "renderingConfiguration": { "target": "com.amazonaws.wisdom#RenderingConfiguration", "traits": { "smithy.api#documentation": "Information about how to render the content.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#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, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.wisdom#CreateKnowledgeBaseResponse": { "type": "structure", "members": { "knowledgeBase": { "target": "com.amazonaws.wisdom#KnowledgeBaseData", "traits": { "smithy.api#documentation": "The knowledge base.
" } } } }, "com.amazonaws.wisdom#CreateQuickResponse": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateQuickResponseRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateQuickResponseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a Wisdom quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#CreateQuickResponseRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { "smithy.api#documentation": "The name of the quick response.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.wisdom#QuickResponseDataProvider", "traits": { "smithy.api#documentation": "The content of the quick response.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#QuickResponseType", "traits": { "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for a quick response written in plain text.
Use application/x.quickresponse;format=markdown for a quick response written in richtext.
The configuration information of the user groups that the quick response is accessible to.
" } }, "description": { "target": "com.amazonaws.wisdom#QuickResponseDescription", "traits": { "smithy.api#documentation": "The description of the quick response.
" } }, "shortcutKey": { "target": "com.amazonaws.wisdom#ShortCutKey", "traits": { "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.\n
" } }, "isActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the quick response is active.
" } }, "channels": { "target": "com.amazonaws.wisdom#Channels", "traits": { "smithy.api#documentation": "The Amazon Connect channels this quick response applies to.
" } }, "language": { "target": "com.amazonaws.wisdom#LanguageCode", "traits": { "smithy.api#documentation": "The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n
A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#CreateQuickResponseResponse": { "type": "structure", "members": { "quickResponse": { "target": "com.amazonaws.wisdom#QuickResponseData", "traits": { "smithy.api#documentation": "The quick response.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#CreateSession": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#CreateSessionRequest" }, "output": { "target": "com.amazonaws.wisdom#CreateSessionResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Wisdom session for each contact on which\n Wisdom is enabled.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#CreateSessionRequest": { "type": "structure", "members": { "clientToken": { "target": "com.amazonaws.wisdom#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 Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the session.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.wisdom#CreateSessionResponse": { "type": "structure", "members": { "session": { "target": "com.amazonaws.wisdom#SessionData", "traits": { "smithy.api#documentation": "The session.
" } } } }, "com.amazonaws.wisdom#DeleteAssistant": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteAssistantRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteAssistantResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an assistant.
", "smithy.api#http": { "uri": "/assistants/{assistantId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#DeleteAssistantAssociation": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteAssistantAssociationRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteAssistantAssociationResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an assistant association.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#DeleteAssistantAssociationRequest": { "type": "structure", "members": { "assistantAssociationId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#DeleteAssistantAssociationResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#DeleteAssistantRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#DeleteAssistantResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#DeleteContent": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteContentRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteContentResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the content.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#DeleteContentRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "contentId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#DeleteContentResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#DeleteImportJob": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteImportJobRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteImportJobResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the quick response import job.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#DeleteImportJobRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "importJobId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the import job to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#DeleteImportJobResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#DeleteKnowledgeBase": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteKnowledgeBaseRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteKnowledgeBaseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the knowledge base.
\nWhen you use this API to delete an external knowledge base such as Salesforce or\n ServiceNow, you must also delete the Amazon AppIntegrations\n DataIntegration. This is because you can't reuse the DataIntegration after it's been\n associated with an external knowledge base. However, you can delete and recreate it. See\n DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API\n Reference.
\nThe knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#DeleteKnowledgeBaseResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#DeleteQuickResponse": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#DeleteQuickResponseRequest" }, "output": { "target": "com.amazonaws.wisdom#DeleteQuickResponseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#DeleteQuickResponseRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "quickResponseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the quick response to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#DeleteQuickResponseResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#Description": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s_.,-]+" } }, "com.amazonaws.wisdom#Document": { "type": "structure", "members": { "contentReference": { "target": "com.amazonaws.wisdom#ContentReference", "traits": { "smithy.api#documentation": "A reference to the content resource.
", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wisdom#DocumentText", "traits": { "smithy.api#documentation": "The title of the document.
" } }, "excerpt": { "target": "com.amazonaws.wisdom#DocumentText", "traits": { "smithy.api#documentation": "The excerpt from the document.
" } } }, "traits": { "smithy.api#documentation": "The document.
" } }, "com.amazonaws.wisdom#DocumentText": { "type": "structure", "members": { "text": { "target": "com.amazonaws.wisdom#SensitiveString", "traits": { "smithy.api#documentation": "Text in the document.
" } }, "highlights": { "target": "com.amazonaws.wisdom#Highlights", "traits": { "smithy.api#documentation": "Highlights in the document text.
" } } }, "traits": { "smithy.api#documentation": "The text of the document.
" } }, "com.amazonaws.wisdom#ExternalSource": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AMAZON_CONNECT", "name": "AMAZON_CONNECT" } ] } }, "com.amazonaws.wisdom#ExternalSourceConfiguration": { "type": "structure", "members": { "source": { "target": "com.amazonaws.wisdom#ExternalSource", "traits": { "smithy.api#documentation": "The type of the external data source.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.wisdom#Configuration", "traits": { "smithy.api#documentation": "The configuration information of the external data source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration information of the external data source.
" } }, "com.amazonaws.wisdom#Filter": { "type": "structure", "members": { "field": { "target": "com.amazonaws.wisdom#FilterField", "traits": { "smithy.api#documentation": "The field on which to filter.
", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.wisdom#FilterOperator", "traits": { "smithy.api#documentation": "The operator to use for comparing the field\u2019s value with the provided value.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The desired field value on which to filter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A search filter.
" } }, "com.amazonaws.wisdom#FilterField": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NAME", "name": "NAME" } ] } }, "com.amazonaws.wisdom#FilterList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#Filter" } }, "com.amazonaws.wisdom#FilterOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EQUALS", "name": "EQUALS" } ] } }, "com.amazonaws.wisdom#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.wisdom#GetAssistant": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetAssistantRequest" }, "output": { "target": "com.amazonaws.wisdom#GetAssistantResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an assistant.
", "smithy.api#http": { "uri": "/assistants/{assistantId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetAssistantAssociation": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetAssistantAssociationRequest" }, "output": { "target": "com.amazonaws.wisdom#GetAssistantAssociationResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an assistant association.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetAssistantAssociationRequest": { "type": "structure", "members": { "assistantAssociationId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetAssistantAssociationResponse": { "type": "structure", "members": { "assistantAssociation": { "target": "com.amazonaws.wisdom#AssistantAssociationData", "traits": { "smithy.api#documentation": "The assistant association.
" } } } }, "com.amazonaws.wisdom#GetAssistantRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetAssistantResponse": { "type": "structure", "members": { "assistant": { "target": "com.amazonaws.wisdom#AssistantData", "traits": { "smithy.api#documentation": "Information about the assistant.
" } } } }, "com.amazonaws.wisdom#GetContent": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetContentRequest" }, "output": { "target": "com.amazonaws.wisdom#GetContentResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves content, including a pre-signed URL to download the content.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetContentRequest": { "type": "structure", "members": { "contentId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetContentResponse": { "type": "structure", "members": { "content": { "target": "com.amazonaws.wisdom#ContentData", "traits": { "smithy.api#documentation": "The content.
" } } } }, "com.amazonaws.wisdom#GetContentSummary": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetContentSummaryRequest" }, "output": { "target": "com.amazonaws.wisdom#GetContentSummaryResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves summary information about the content.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetContentSummaryRequest": { "type": "structure", "members": { "contentId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetContentSummaryResponse": { "type": "structure", "members": { "contentSummary": { "target": "com.amazonaws.wisdom#ContentSummary", "traits": { "smithy.api#documentation": "The content summary.
" } } } }, "com.amazonaws.wisdom#GetImportJob": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetImportJobRequest" }, "output": { "target": "com.amazonaws.wisdom#GetImportJobResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the started import job.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetImportJobRequest": { "type": "structure", "members": { "importJobId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the import job to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base that the import job belongs to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#GetImportJobResponse": { "type": "structure", "members": { "importJob": { "target": "com.amazonaws.wisdom#ImportJobData", "traits": { "smithy.api#documentation": "The import job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#GetKnowledgeBase": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetKnowledgeBaseRequest" }, "output": { "target": "com.amazonaws.wisdom#GetKnowledgeBaseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about the knowledge base.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetKnowledgeBaseRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetKnowledgeBaseResponse": { "type": "structure", "members": { "knowledgeBase": { "target": "com.amazonaws.wisdom#KnowledgeBaseData", "traits": { "smithy.api#documentation": "The knowledge base.
" } } } }, "com.amazonaws.wisdom#GetQuickResponse": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetQuickResponseRequest" }, "output": { "target": "com.amazonaws.wisdom#GetQuickResponseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetQuickResponseRequest": { "type": "structure", "members": { "quickResponseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the quick response.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#GetQuickResponseResponse": { "type": "structure", "members": { "quickResponse": { "target": "com.amazonaws.wisdom#QuickResponseData", "traits": { "smithy.api#documentation": "The quick response.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#GetRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetRecommendationsRequest" }, "output": { "target": "com.amazonaws.wisdom#GetRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#deprecated": { "message": "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, "smithy.api#documentation": "Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "waitTimeSeconds": { "target": "com.amazonaws.wisdom#WaitTimeSeconds", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The duration (in seconds) for which the call waits for a recommendation to be made\n available before returning. If a recommendation is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time expires, the\n call returns successfully with an empty list.
The recommendations.
", "smithy.api#required": {} } }, "triggers": { "target": "com.amazonaws.wisdom#RecommendationTriggerList", "traits": { "smithy.api#documentation": "The triggers corresponding to recommendations.
" } } } }, "com.amazonaws.wisdom#GetSession": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#GetSessionRequest" }, "output": { "target": "com.amazonaws.wisdom#GetSessionResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information for a specified session.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions/{sessionId}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#GetSessionRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#GetSessionResponse": { "type": "structure", "members": { "session": { "target": "com.amazonaws.wisdom#SessionData", "traits": { "smithy.api#documentation": "The session.
" } } } }, "com.amazonaws.wisdom#GroupingConfiguration": { "type": "structure", "members": { "criteria": { "target": "com.amazonaws.wisdom#GroupingCriteria", "traits": { "smithy.api#documentation": "The criteria used for grouping Wisdom users.
\nThe following is the list of supported criteria values.
\n\n RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and\n DescribeRoutingProfile permissions when setting criteria to this value.
The list of values that define different groups of Wisdom users.
\nWhen setting criteria to RoutingProfileArn, you need to provide a list of\n ARNs of Amazon Connect routing profiles as values of this parameter.
The configuration information of the grouping of Wisdom users.
" } }, "com.amazonaws.wisdom#GroupingCriteria": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#GroupingValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#GroupingValues": { "type": "list", "member": { "target": "com.amazonaws.wisdom#GroupingValue" }, "traits": { "smithy.api#uniqueItems": {} } }, "com.amazonaws.wisdom#Headers": { "type": "map", "key": { "target": "com.amazonaws.wisdom#NonEmptyString" }, "value": { "target": "com.amazonaws.wisdom#NonEmptyString" } }, "com.amazonaws.wisdom#Highlight": { "type": "structure", "members": { "beginOffsetInclusive": { "target": "com.amazonaws.wisdom#HighlightOffset", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The offset for the start of the highlight.
" } }, "endOffsetExclusive": { "target": "com.amazonaws.wisdom#HighlightOffset", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The offset for the end of the highlight.
" } } }, "traits": { "smithy.api#documentation": "Offset specification to describe highlighting of document excerpts for rendering search\n results and recommendations.
" } }, "com.amazonaws.wisdom#HighlightOffset": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.wisdom#Highlights": { "type": "list", "member": { "target": "com.amazonaws.wisdom#Highlight" } }, "com.amazonaws.wisdom#ImportJobData": { "type": "structure", "members": { "importJobId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the import job.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.wisdom#UploadId", "traits": { "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "importJobType": { "target": "com.amazonaws.wisdom#ImportJobType", "traits": { "smithy.api#documentation": "The type of the import job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#ImportJobStatus", "traits": { "smithy.api#documentation": "The status of the import job.
", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "The download link to the resource file that is uploaded to the import job.
", "smithy.api#required": {} } }, "failedRecordReport": { "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "The link to donwload the information of resource data that failed to be imported.
" } }, "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" } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the import job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the import job data was last modified.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "metadata": { "target": "com.amazonaws.wisdom#ContentMetadata", "traits": { "smithy.api#documentation": "The metadata fields of the imported Wisdom resources.
" } }, "externalSourceConfiguration": { "target": "com.amazonaws.wisdom#ExternalSourceConfiguration" } }, "traits": { "smithy.api#documentation": "Summary information about the import job.
" } }, "com.amazonaws.wisdom#ImportJobList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#ImportJobSummary" } }, "com.amazonaws.wisdom#ImportJobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "START_IN_PROGRESS", "name": "START_IN_PROGRESS" }, { "value": "FAILED", "name": "FAILED" }, { "value": "COMPLETE", "name": "COMPLETE" }, { "value": "DELETE_IN_PROGRESS", "name": "DELETE_IN_PROGRESS" }, { "value": "DELETE_FAILED", "name": "DELETE_FAILED" }, { "value": "DELETED", "name": "DELETED" } ] } }, "com.amazonaws.wisdom#ImportJobSummary": { "type": "structure", "members": { "importJobId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the import job.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.wisdom#UploadId", "traits": { "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "importJobType": { "target": "com.amazonaws.wisdom#ImportJobType", "traits": { "smithy.api#documentation": "The type of import job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#ImportJobStatus", "traits": { "smithy.api#documentation": "The status of the import job.
", "smithy.api#required": {} } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the import job was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the import job was last modified.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "metadata": { "target": "com.amazonaws.wisdom#ContentMetadata", "traits": { "smithy.api#documentation": "The metadata fields of the imported Wisdom resources.
" } }, "externalSourceConfiguration": { "target": "com.amazonaws.wisdom#ExternalSourceConfiguration", "traits": { "smithy.api#documentation": "The configuration information of the external source that the resource data are imported from.
" } } }, "traits": { "smithy.api#documentation": "Summary information about the import job.
" } }, "com.amazonaws.wisdom#ImportJobType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "QUICK_RESPONSES", "name": "QUICK_RESPONSES" } ] } }, "com.amazonaws.wisdom#KnowledgeBase": { "type": "resource", "identifiers": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateKnowledgeBase" }, "read": { "target": "com.amazonaws.wisdom#GetKnowledgeBase" }, "delete": { "target": "com.amazonaws.wisdom#DeleteKnowledgeBase" }, "list": { "target": "com.amazonaws.wisdom#ListKnowledgeBases" }, "operations": [ { "target": "com.amazonaws.wisdom#DeleteImportJob" }, { "target": "com.amazonaws.wisdom#GetImportJob" }, { "target": "com.amazonaws.wisdom#ListImportJobs" }, { "target": "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUri" }, { "target": "com.amazonaws.wisdom#SearchContent" }, { "target": "com.amazonaws.wisdom#SearchQuickResponses" }, { "target": "com.amazonaws.wisdom#StartContentUpload" }, { "target": "com.amazonaws.wisdom#StartImportJob" }, { "target": "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUri" } ], "resources": [ { "target": "com.amazonaws.wisdom#Content" }, { "target": "com.amazonaws.wisdom#QuickResponse" } ], "traits": { "aws.api#arn": { "template": "knowledge-base/{knowledgeBaseId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#KnowledgeBaseAssociationData": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
" } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
" } } }, "traits": { "smithy.api#documentation": "Association information about the knowledge base.
" } }, "com.amazonaws.wisdom#KnowledgeBaseData": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseType": { "target": "com.amazonaws.wisdom#KnowledgeBaseType", "traits": { "smithy.api#documentation": "The type of knowledge base.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#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" } }, "sourceConfiguration": { "target": "com.amazonaws.wisdom#SourceConfiguration", "traits": { "smithy.api#documentation": "Source configuration information about the knowledge base.
" } }, "renderingConfiguration": { "target": "com.amazonaws.wisdom#RenderingConfiguration", "traits": { "smithy.api#documentation": "Information about how to render the content.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#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, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "Information about the knowledge base.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#KnowledgeBaseList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#KnowledgeBaseSummary" } }, "com.amazonaws.wisdom#KnowledgeBaseStatus": { "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.wisdom#KnowledgeBaseSummary": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseType": { "target": "com.amazonaws.wisdom#KnowledgeBaseType", "traits": { "smithy.api#documentation": "The type of knowledge base.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wisdom#KnowledgeBaseStatus", "traits": { "smithy.api#documentation": "The status of the knowledge base summary.
", "smithy.api#required": {} } }, "sourceConfiguration": { "target": "com.amazonaws.wisdom#SourceConfiguration", "traits": { "smithy.api#documentation": "Configuration information about the external data source.
" } }, "renderingConfiguration": { "target": "com.amazonaws.wisdom#RenderingConfiguration", "traits": { "smithy.api#documentation": "Information about how to render the content.
" } }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.wisdom#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/kms:GenerateDataKey permissions to the IAM identity using the key\n to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom\n for your instance.
" } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description of the knowledge base.
" } }, "tags": { "target": "com.amazonaws.wisdom#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 knowledge base.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#KnowledgeBaseType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EXTERNAL", "name": "EXTERNAL" }, { "value": "CUSTOM", "name": "CUSTOM" }, { "value": "QUICK_RESPONSES", "name": "QUICK_RESPONSES" } ] } }, "com.amazonaws.wisdom#LanguageCode": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 5 } } }, "com.amazonaws.wisdom#ListAssistantAssociations": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListAssistantAssociationsRequest" }, "output": { "target": "com.amazonaws.wisdom#ListAssistantAssociationsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists information about assistant associations.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/associations", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "assistantAssociationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListAssistantAssociationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#ListAssistantAssociationsResponse": { "type": "structure", "members": { "assistantAssociationSummaries": { "target": "com.amazonaws.wisdom#AssistantAssociationSummaryList", "traits": { "smithy.api#documentation": "Summary information about assistant associations.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#ListAssistants": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListAssistantsRequest" }, "output": { "target": "com.amazonaws.wisdom#ListAssistantsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists information about assistants.
", "smithy.api#http": { "uri": "/assistants", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "assistantSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListAssistantsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.wisdom#ListAssistantsResponse": { "type": "structure", "members": { "assistantSummaries": { "target": "com.amazonaws.wisdom#AssistantList", "traits": { "smithy.api#documentation": "Information about the assistants.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#ListContents": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListContentsRequest" }, "output": { "target": "com.amazonaws.wisdom#ListContentsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the content.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "contentSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListContentsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#ListContentsResponse": { "type": "structure", "members": { "contentSummaries": { "target": "com.amazonaws.wisdom#ContentSummaryList", "traits": { "smithy.api#documentation": "Information about the content.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#ListImportJobs": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListImportJobsRequest" }, "output": { "target": "com.amazonaws.wisdom#ListImportJobsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists information about import jobs.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/importJobs", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "importJobSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListImportJobsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. 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.wisdom#ListImportJobsResponse": { "type": "structure", "members": { "importJobSummaries": { "target": "com.amazonaws.wisdom#ImportJobList", "traits": { "smithy.api#documentation": "Summary information about the import jobs.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#ListKnowledgeBases": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListKnowledgeBasesRequest" }, "output": { "target": "com.amazonaws.wisdom#ListKnowledgeBasesResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the knowledge bases.
", "smithy.api#http": { "uri": "/knowledgeBases", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "knowledgeBaseSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListKnowledgeBasesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.wisdom#ListKnowledgeBasesResponse": { "type": "structure", "members": { "knowledgeBaseSummaries": { "target": "com.amazonaws.wisdom#KnowledgeBaseList", "traits": { "smithy.api#documentation": "Information about the knowledge bases.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#ListQuickResponses": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListQuickResponsesRequest" }, "output": { "target": "com.amazonaws.wisdom#ListQuickResponsesResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists information about quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses", "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "quickResponseSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListQuickResponsesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. 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.wisdom#ListQuickResponsesResponse": { "type": "structure", "members": { "quickResponseSummaries": { "target": "com.amazonaws.wisdom#QuickResponseSummaryList", "traits": { "smithy.api#documentation": "Summary information about the quick responses.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.wisdom#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the tags for the specified resource.
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } } }, "com.amazonaws.wisdom#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.wisdom#Name": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s_.,-]+" } }, "com.amazonaws.wisdom#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wisdom#NonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.wisdom#NotifyRecommendationsReceived": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceivedRequest" }, "output": { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceivedResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes the specified recommendations from the specified assistant's queue of newly\n available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling\n behavior and avoiding duplicate recommendations.
The identifier of the recommendation that is in error.
" } }, "message": { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceivedErrorMessage", "traits": { "smithy.api#documentation": "A recommendation is causing an error.
" } } }, "traits": { "smithy.api#documentation": "An error occurred when creating a recommendation.
" } }, "com.amazonaws.wisdom#NotifyRecommendationsReceivedErrorList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceivedError" } }, "com.amazonaws.wisdom#NotifyRecommendationsReceivedErrorMessage": { "type": "string" }, "com.amazonaws.wisdom#NotifyRecommendationsReceivedRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "recommendationIds": { "target": "com.amazonaws.wisdom#RecommendationIdList", "traits": { "smithy.api#documentation": "The identifiers of the recommendations.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#NotifyRecommendationsReceivedResponse": { "type": "structure", "members": { "recommendationIds": { "target": "com.amazonaws.wisdom#RecommendationIdList", "traits": { "smithy.api#documentation": "The identifiers of the recommendations.
" } }, "errors": { "target": "com.amazonaws.wisdom#NotifyRecommendationsReceivedErrorList", "traits": { "smithy.api#documentation": "The identifiers of recommendations that are causing errors.
" } } } }, "com.amazonaws.wisdom#ObjectFieldsList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.wisdom#Order": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASC", "name": "ASC" }, { "value": "DESC", "name": "DESC" } ] } }, "com.amazonaws.wisdom#PreconditionFailedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The provided revisionId does not match, indicating the content has been\n modified since it was last read.
Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n
", "smithy.api#http": { "uri": "/assistants/{assistantId}/query", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "results" }, "smithy.api#readonly": {}, "smithy.api#suppress": [ "HttpMethodSemantics" ] } }, "com.amazonaws.wisdom#QueryAssistantRequest": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "queryText": { "target": "com.amazonaws.wisdom#QueryText", "traits": { "smithy.api#documentation": "The text to search for.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
" } } } }, "com.amazonaws.wisdom#QueryAssistantResponse": { "type": "structure", "members": { "results": { "target": "com.amazonaws.wisdom#QueryResultsList", "traits": { "smithy.api#documentation": "The results of the query.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#QueryRecommendationTriggerData": { "type": "structure", "members": { "text": { "target": "com.amazonaws.wisdom#QueryText", "traits": { "smithy.api#documentation": "The text associated with the recommendation trigger.
" } } }, "traits": { "smithy.api#documentation": "Data associated with the QUERY RecommendationTriggerType.
" } }, "com.amazonaws.wisdom#QueryResultsList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#ResultData" } }, "com.amazonaws.wisdom#QueryText": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#QuickResponse": { "type": "resource", "identifiers": { "quickResponseId": { "target": "com.amazonaws.wisdom#UuidOrArn" }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateQuickResponse" }, "read": { "target": "com.amazonaws.wisdom#GetQuickResponse" }, "update": { "target": "com.amazonaws.wisdom#UpdateQuickResponse" }, "delete": { "target": "com.amazonaws.wisdom#DeleteQuickResponse" }, "list": { "target": "com.amazonaws.wisdom#ListQuickResponses" }, "traits": { "aws.api#arn": { "template": "quick-response/{knowledgeBaseId}/{quickResponseId}" }, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#QuickResponseContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#QuickResponseContentProvider": { "type": "union", "members": { "content": { "target": "com.amazonaws.wisdom#QuickResponseContent", "traits": { "smithy.api#documentation": "The content of the quick response.
" } } }, "traits": { "smithy.api#documentation": "The container quick response content.
" } }, "com.amazonaws.wisdom#QuickResponseContents": { "type": "structure", "members": { "plainText": { "target": "com.amazonaws.wisdom#QuickResponseContentProvider" }, "markdown": { "target": "com.amazonaws.wisdom#QuickResponseContentProvider" } }, "traits": { "smithy.api#documentation": "The content of the quick response stored in different media types.
" } }, "com.amazonaws.wisdom#QuickResponseData": { "type": "structure", "members": { "quickResponseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quick response.
", "smithy.api#required": {} } }, "quickResponseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the quick response.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { "smithy.api#documentation": "The name of the quick response.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#QuickResponseType", "traits": { "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The status of the quick response data.
", "smithy.api#required": {} } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response data was last modified.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "contents": { "target": "com.amazonaws.wisdom#QuickResponseContents", "traits": { "smithy.api#documentation": "The contents of the quick response.
" } }, "description": { "target": "com.amazonaws.wisdom#QuickResponseDescription", "traits": { "smithy.api#documentation": "The description of the quick response.
" } }, "groupingConfiguration": { "target": "com.amazonaws.wisdom#GroupingConfiguration", "traits": { "smithy.api#documentation": "The configuration information of the user groups that the quick response is accessible to.
" } }, "shortcutKey": { "target": "com.amazonaws.wisdom#ShortCutKey", "traits": { "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.
" } }, "lastModifiedBy": { "target": "com.amazonaws.wisdom#GenericArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" } }, "isActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the quick response is active.
" } }, "channels": { "target": "com.amazonaws.wisdom#Channels", "traits": { "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The language code value for the language in which the quick response is written.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "Information about the quick response.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#QuickResponse" }, { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#QuickResponseDataProvider": { "type": "union", "members": { "content": { "target": "com.amazonaws.wisdom#QuickResponseContent", "traits": { "smithy.api#documentation": "The content of the quick response.
" } } }, "traits": { "smithy.api#documentation": "The container of quick response data.
" } }, "com.amazonaws.wisdom#QuickResponseDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.wisdom#QuickResponseFilterField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The name of the attribute field to filter the quick responses by.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.wisdom#QuickResponseFilterValueList", "traits": { "smithy.api#documentation": "The values of attribute field to filter the quick response by.
" } }, "operator": { "target": "com.amazonaws.wisdom#QuickResponseFilterOperator", "traits": { "smithy.api#documentation": "The operator to use for filtering.
", "smithy.api#required": {} } }, "includeNoExistence": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to treat null value as a match for the attribute field.
" } } }, "traits": { "smithy.api#documentation": "The quick response fields to filter the quick response query results by.
\nThe following is the list of supported field names.
\nname
\ndescription
\nshortcutKey
\nisActive
\nchannels
\nlanguage
\ncontentType
\ncreatedTime
\nlastModifiedTime
\nlastModifiedBy
\ngroupingConfiguration.criteria
\ngroupingConfiguration.values
\nThe name of the attribute to order the quick response query results by.
", "smithy.api#required": {} } }, "order": { "target": "com.amazonaws.wisdom#Order", "traits": { "smithy.api#documentation": "The order at which the quick responses are sorted by.
" } } }, "traits": { "smithy.api#documentation": "The quick response fields to order the quick response query results by.
\nThe following is the list of supported field names.
\nname
\ndescription
\nshortcutKey
\nisActive
\nchannels
\nlanguage
\ncontentType
\ncreatedTime
\nlastModifiedTime
\nlastModifiedBy
\ngroupingConfiguration.criteria
\ngroupingConfiguration.values
\nThe name of the attribute to query the quick responses by.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.wisdom#QuickResponseQueryValueList", "traits": { "smithy.api#documentation": "The values of the attribute to query the quick responses by.
", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.wisdom#QuickResponseQueryOperator", "traits": { "smithy.api#documentation": "The operator to use for matching attribute field values in the query.
", "smithy.api#required": {} } }, "allowFuzziness": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
" } }, "priority": { "target": "com.amazonaws.wisdom#Priority", "traits": { "smithy.api#documentation": "The importance of the attribute field when calculating query result relevancy scores.\n The value set for this parameter affects the ordering of search results.
" } } }, "traits": { "smithy.api#documentation": "The quick response fields to query quick responses by.
\nThe following is the list of supported field names.
\ncontent
\nname
\ndescription
\nshortcutKey
\nThe quick response query expressions.
" } }, "filters": { "target": "com.amazonaws.wisdom#QuickResponseFilterFieldList", "traits": { "smithy.api#documentation": "The configuration of filtering rules applied to quick response query results.
" } }, "orderOnField": { "target": "com.amazonaws.wisdom#QuickResponseOrderField", "traits": { "smithy.api#documentation": "The quick response attribute fields on which the query results are ordered.
" } } }, "traits": { "smithy.api#documentation": "Information about the import job.
" } }, "com.amazonaws.wisdom#QuickResponseSearchResultData": { "type": "structure", "members": { "quickResponseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quick response.
", "smithy.api#required": {} } }, "quickResponseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the quick response.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { "smithy.api#documentation": "The name of the quick response.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#QuickResponseType", "traits": { "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The resource status of the quick response.
", "smithy.api#required": {} } }, "contents": { "target": "com.amazonaws.wisdom#QuickResponseContents", "traits": { "smithy.api#documentation": "The contents of the quick response.
", "smithy.api#required": {} } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response search result data was last modified.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "isActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the quick response is active.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#QuickResponseDescription", "traits": { "smithy.api#documentation": "The description of the quick response.
" } }, "groupingConfiguration": { "target": "com.amazonaws.wisdom#GroupingConfiguration", "traits": { "smithy.api#documentation": "The configuration information of the user groups that the quick response is accessible to.
" } }, "shortcutKey": { "target": "com.amazonaws.wisdom#ShortCutKey", "traits": { "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.
" } }, "lastModifiedBy": { "target": "com.amazonaws.wisdom#GenericArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
" } }, "channels": { "target": "com.amazonaws.wisdom#Channels", "traits": { "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The language code value for the language in which the quick response is written.
" } }, "attributesNotInterpolated": { "target": "com.amazonaws.wisdom#ContactAttributeKeys", "traits": { "smithy.api#documentation": "The user defined contact attributes that are not resolved when the search result is returned.
" } }, "attributesInterpolated": { "target": "com.amazonaws.wisdom#ContactAttributeKeys", "traits": { "smithy.api#documentation": "The user defined contact attributes that are resolved when the search result is returned.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "The result of quick response search.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#QuickResponse" }, { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#QuickResponseSearchResultsList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#QuickResponseSearchResultData" } }, "com.amazonaws.wisdom#QuickResponseStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", "name": "CREATE_IN_PROGRESS" }, { "value": "CREATE_FAILED", "name": "CREATE_FAILED" }, { "value": "CREATED", "name": "CREATED" }, { "value": "DELETE_IN_PROGRESS", "name": "DELETE_IN_PROGRESS" }, { "value": "DELETE_FAILED", "name": "DELETE_FAILED" }, { "value": "DELETED", "name": "DELETED" }, { "value": "UPDATE_IN_PROGRESS", "name": "UPDATE_IN_PROGRESS" }, { "value": "UPDATE_FAILED", "name": "UPDATE_FAILED" } ] } }, "com.amazonaws.wisdom#QuickResponseSummary": { "type": "structure", "members": { "quickResponseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the quick response.
", "smithy.api#required": {} } }, "quickResponseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the quick response.
", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { "smithy.api#documentation": "The name of the quick response.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#QuickResponseType", "traits": { "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The resource status of the quick response.
", "smithy.api#required": {} } }, "createdTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "lastModifiedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the quick response summary was last modified.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "epoch-seconds" } }, "description": { "target": "com.amazonaws.wisdom#QuickResponseDescription", "traits": { "smithy.api#documentation": "The description of the quick response.
" } }, "lastModifiedBy": { "target": "com.amazonaws.wisdom#GenericArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user who last updated the quick response data.
" } }, "isActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the quick response is active.
" } }, "channels": { "target": "com.amazonaws.wisdom#Channels", "traits": { "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The tags used to organize, track, or control access for this resource.
" } } }, "traits": { "smithy.api#documentation": "The summary information about the quick response.
", "smithy.api#references": [ { "resource": "com.amazonaws.wisdom#QuickResponse" }, { "resource": "com.amazonaws.wisdom#KnowledgeBase" } ] } }, "com.amazonaws.wisdom#QuickResponseSummaryList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#QuickResponseSummary" } }, "com.amazonaws.wisdom#QuickResponseType": { "type": "string", "traits": { "smithy.api#pattern": "^(application/x\\.quickresponse;format=(plain|markdown))$" } }, "com.amazonaws.wisdom#RecommendationData": { "type": "structure", "members": { "recommendationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the recommendation.
", "smithy.api#required": {} } }, "document": { "target": "com.amazonaws.wisdom#Document", "traits": { "smithy.api#documentation": "The recommended document.
", "smithy.api#required": {} } }, "relevanceScore": { "target": "com.amazonaws.wisdom#RelevanceScore", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The relevance score of the recommendation.
" } }, "relevanceLevel": { "target": "com.amazonaws.wisdom#RelevanceLevel", "traits": { "smithy.api#documentation": "The relevance level of the recommendation.
" } }, "type": { "target": "com.amazonaws.wisdom#RecommendationType", "traits": { "smithy.api#documentation": "The type of recommendation.
" } } }, "traits": { "smithy.api#documentation": "Information about the recommendation.
" } }, "com.amazonaws.wisdom#RecommendationIdList": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.wisdom#RecommendationList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#RecommendationData" } }, "com.amazonaws.wisdom#RecommendationSourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ISSUE_DETECTION", "name": "ISSUE_DETECTION" }, { "value": "RULE_EVALUATION", "name": "RULE_EVALUATION" }, { "value": "OTHER", "name": "OTHER" } ] } }, "com.amazonaws.wisdom#RecommendationTrigger": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the recommendation trigger.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wisdom#RecommendationTriggerType", "traits": { "smithy.api#documentation": "The type of recommendation trigger.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.wisdom#RecommendationSourceType", "traits": { "smithy.api#documentation": "The source of the recommendation trigger.
\nISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens\n issue.
\nRULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens\n rule.
\nA union type containing information related to the trigger.
", "smithy.api#required": {} } }, "recommendationIds": { "target": "com.amazonaws.wisdom#RecommendationIdList", "traits": { "smithy.api#documentation": "The identifiers of the recommendations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A recommendation trigger provides context on the event that produced the referenced\n recommendations. Recommendations are only referenced in recommendationIds by a\n single RecommendationTrigger.
Data associated with the QUERY RecommendationTriggerType.
" } } }, "traits": { "smithy.api#documentation": "A union type containing information related to the trigger.
" } }, "com.amazonaws.wisdom#RecommendationTriggerList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#RecommendationTrigger" } }, "com.amazonaws.wisdom#RecommendationTriggerType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "QUERY", "name": "QUERY" } ] } }, "com.amazonaws.wisdom#RecommendationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "KNOWLEDGE_CONTENT", "name": "KNOWLEDGE_CONTENT" } ] } }, "com.amazonaws.wisdom#RelevanceLevel": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "HIGH", "name": "HIGH" }, { "value": "MEDIUM", "name": "MEDIUM" }, { "value": "LOW", "name": "LOW" } ] } }, "com.amazonaws.wisdom#RelevanceScore": { "type": "double", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0.0 } } }, "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUri": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUriRequest" }, "output": { "target": "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUriResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a URI template from a knowledge base.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", "method": "DELETE", "code": 204 } } }, "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUriRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#RemoveKnowledgeBaseTemplateUriResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#RenderingConfiguration": { "type": "structure", "members": { "templateUri": { "target": "com.amazonaws.wisdom#Uri", "traits": { "smithy.api#documentation": "A URI template containing exactly one variable in ${variableName} format.\n This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow,\n and Zendesk, the variable must be one of the following:
Salesforce: Id, ArticleNumber, VersionNumber,\n Title, PublishStatus, or IsDeleted\n
ServiceNow: number, short_description,\n sys_mod_count, workflow_state, or active\n
Zendesk: id, title, updated_at, or\n draft\n
The variable is replaced with the actual value for a piece of content when calling GetContent.
" } } }, "traits": { "smithy.api#documentation": "Information about how to render the content.
" } }, "com.amazonaws.wisdom#RequestTimeoutException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The request reached the service more than 15 minutes after the date stamp on the request\n or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or\n the date stamp on the request is more than 15 minutes in the future.
", "smithy.api#error": "client", "smithy.api#httpError": 408, "smithy.api#retryable": {} } }, "com.amazonaws.wisdom#ResourceNotFoundException": { "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": "The specified resource does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.wisdom#ResultData": { "type": "structure", "members": { "resultId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the result data.
", "smithy.api#required": {} } }, "document": { "target": "com.amazonaws.wisdom#Document", "traits": { "smithy.api#documentation": "The document.
", "smithy.api#required": {} } }, "relevanceScore": { "target": "com.amazonaws.wisdom#RelevanceScore", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The relevance score of the results.
" } } }, "traits": { "smithy.api#documentation": "Information about the result.
" } }, "com.amazonaws.wisdom#SearchContent": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#SearchContentRequest" }, "output": { "target": "com.amazonaws.wisdom#SearchContentResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/search", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "contentSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#SearchContentRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "searchExpression": { "target": "com.amazonaws.wisdom#SearchExpression", "traits": { "smithy.api#documentation": "The search expression to filter results.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#SearchContentResponse": { "type": "structure", "members": { "contentSummaries": { "target": "com.amazonaws.wisdom#ContentSummaryList", "traits": { "smithy.api#documentation": "Summary information about the content.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#SearchExpression": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.wisdom#FilterList", "traits": { "smithy.api#documentation": "The search expression filters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The search expression.
" } }, "com.amazonaws.wisdom#SearchQuickResponses": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#SearchQuickResponsesRequest" }, "output": { "target": "com.amazonaws.wisdom#SearchQuickResponsesResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#RequestTimeoutException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Searches existing Wisdom quick responses in a Wisdom knowledge base.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "results" } } }, "com.amazonaws.wisdom#SearchQuickResponsesRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "searchExpression": { "target": "com.amazonaws.wisdom#QuickResponseSearchExpression", "traits": { "smithy.api#documentation": "The search expression for querying the quick response.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "attributes": { "target": "com.amazonaws.wisdom#ContactAttributes", "traits": { "smithy.api#documentation": "The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#SearchQuickResponsesResponse": { "type": "structure", "members": { "results": { "target": "com.amazonaws.wisdom#QuickResponseSearchResultsList", "traits": { "smithy.api#documentation": "The results of the quick response search.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#SearchSessions": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#SearchSessionsRequest" }, "output": { "target": "com.amazonaws.wisdom#SearchSessionsResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Searches for sessions.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/searchSessions", "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "sessionSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.wisdom#SearchSessionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.wisdom#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return per page.
", "smithy.api#httpQuery": "maxResults" } }, "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "searchExpression": { "target": "com.amazonaws.wisdom#SearchExpression", "traits": { "smithy.api#documentation": "The search expression to filter results.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#SearchSessionsResponse": { "type": "structure", "members": { "sessionSummaries": { "target": "com.amazonaws.wisdom#SessionSummaries", "traits": { "smithy.api#documentation": "Summary information about the sessions.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wisdom#NextToken", "traits": { "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" } } } }, "com.amazonaws.wisdom#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#ServerSideEncryptionConfiguration": { "type": "structure", "members": { "kmsKeyId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The customer managed key used for encryption. For more information about setting up a\n customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your\n instance. For information about valid ID values, see Key identifiers (KeyId).
" } } }, "traits": { "smithy.api#documentation": "The configuration information for the customer managed key used for encryption.
" } }, "com.amazonaws.wisdom#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "You've exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use service quotas to request a service quota increase.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.wisdom#Session": { "type": "resource", "identifiers": { "assistantId": { "target": "com.amazonaws.wisdom#UuidOrArn" }, "sessionId": { "target": "com.amazonaws.wisdom#UuidOrArn" } }, "create": { "target": "com.amazonaws.wisdom#CreateSession" }, "read": { "target": "com.amazonaws.wisdom#GetSession" }, "traits": { "aws.api#arn": { "template": "session/{assistantId}/{sessionId}" }, "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.wisdom#SessionData": { "type": "structure", "members": { "sessionArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the session.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#Name", "traits": { "smithy.api#documentation": "The name of the session.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wisdom#Description", "traits": { "smithy.api#documentation": "The description of the session.
" } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } }, "integrationConfiguration": { "target": "com.amazonaws.wisdom#SessionIntegrationConfiguration", "traits": { "smithy.api#documentation": "The configuration information for the session integration.
" } } }, "traits": { "smithy.api#documentation": "Information about the session.
" } }, "com.amazonaws.wisdom#SessionIntegrationConfiguration": { "type": "structure", "members": { "topicIntegrationArn": { "target": "com.amazonaws.wisdom#GenericArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
" } } }, "traits": { "smithy.api#documentation": "The configuration information for the session integration.
" } }, "com.amazonaws.wisdom#SessionSummaries": { "type": "list", "member": { "target": "com.amazonaws.wisdom#SessionSummary" } }, "com.amazonaws.wisdom#SessionSummary": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the session.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", "smithy.api#required": {} } }, "assistantId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { "smithy.api#documentation": "The identifier of the Wisdom assistant.
", "smithy.api#required": {} } }, "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Wisdom assistant.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Summary information about the session.
" } }, "com.amazonaws.wisdom#ShortCutKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.wisdom#SourceConfiguration": { "type": "union", "members": { "appIntegrations": { "target": "com.amazonaws.wisdom#AppIntegrationsConfiguration", "traits": { "smithy.api#documentation": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" } } }, "traits": { "smithy.api#documentation": "Configuration information about the external data source.
" } }, "com.amazonaws.wisdom#StartContentUpload": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#StartContentUploadRequest" }, "output": { "target": "com.amazonaws.wisdom#StartContentUploadResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/upload", "method": "POST" } } }, "com.amazonaws.wisdom#StartContentUploadRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.wisdom#ContentType", "traits": { "smithy.api#documentation": "The type of content to upload.
", "smithy.api#required": {} } }, "presignedUrlTimeToLive": { "target": "com.amazonaws.wisdom#TimeToLive", "traits": { "smithy.api#documentation": "The expected expiration time of the generated presigned URL, specified in minutes.
" } } } }, "com.amazonaws.wisdom#StartContentUploadResponse": { "type": "structure", "members": { "uploadId": { "target": "com.amazonaws.wisdom#UploadId", "traits": { "smithy.api#documentation": "The identifier of the upload.
", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "The URL of the upload.
", "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" } }, "headersToInclude": { "target": "com.amazonaws.wisdom#Headers", "traits": { "smithy.api#documentation": "The headers to include in the upload.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#StartImportJob": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#StartImportJobRequest" }, "output": { "target": "com.amazonaws.wisdom#StartImportJobResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to\n upload an asset that contains the resource data.
\nFor importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
\nThe identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
\nFor importing Wisdom quick responses, this should be a QUICK_RESPONSES type knowledge base.
The type of the import job.
\nFor importing quick response resource, set the value to QUICK_RESPONSES.
A pointer to the uploaded asset. This value is returned by StartContentUpload.
", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", "smithy.api#idempotencyToken": {} } }, "metadata": { "target": "com.amazonaws.wisdom#ContentMetadata", "traits": { "smithy.api#documentation": "The metadata fields of the imported Wisdom resources.
" } }, "externalSourceConfiguration": { "target": "com.amazonaws.wisdom#ExternalSourceConfiguration", "traits": { "smithy.api#documentation": "The configuration information of the external source that the resource data are imported from.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wisdom#StartImportJobResponse": { "type": "structure", "members": { "importJob": { "target": "com.amazonaws.wisdom#ImportJobData", "traits": { "smithy.api#documentation": "The import job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.wisdom#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.wisdom#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wisdom#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#TagResourceRequest" }, "output": { "target": "com.amazonaws.wisdom#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Adds the specified tags to the specified resource.
", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.wisdom#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.wisdom#Tags", "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.wisdom#Tags": { "type": "map", "key": { "target": "com.amazonaws.wisdom#TagKey" }, "value": { "target": "com.amazonaws.wisdom#TagValue" } }, "com.amazonaws.wisdom#TimeToLive": { "type": "integer", "traits": { "smithy.api#documentation": "Expiration time in minutes", "smithy.api#range": { "min": 1, "max": 60 } } }, "com.amazonaws.wisdom#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 Connect Wisdom throws this exception if you have too many tags in your tag set.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.wisdom#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#UntagResourceRequest" }, "output": { "target": "com.amazonaws.wisdom#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#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.wisdom#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.wisdom#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.wisdom#UpdateContent": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#UpdateContentRequest" }, "output": { "target": "com.amazonaws.wisdom#UpdateContentResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#PreconditionFailedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates information about the content.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", "method": "POST" } } }, "com.amazonaws.wisdom#UpdateContentRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "contentId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "revisionId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { "smithy.api#documentation": "The revisionId of the content resource to update, taken from an earlier call\n to GetContent, GetContentSummary, SearchContent, or\n ListContents. If included, this argument acts as an optimistic lock to ensure\n content was not modified since it was last read. If it has been modified, this API throws a\n PreconditionFailedException.
The title of the content.
" } }, "overrideLinkOutUri": { "target": "com.amazonaws.wisdom#Uri", "traits": { "smithy.api#documentation": "The URI for the article. If the knowledge base has a templateUri, setting this argument\n overrides it for this piece of content. To remove an existing overrideLinkOurUri,\n exclude this argument and set removeOverrideLinkOutUri to true.
Unset the existing overrideLinkOutUri if it exists.
A key/value map to store attributes without affecting tagging or recommendations. For\n example, when synchronizing data between an external system and Wisdom, you can store an\n external version identifier as metadata to utilize for determining drift.
" } }, "uploadId": { "target": "com.amazonaws.wisdom#UploadId", "traits": { "smithy.api#documentation": "A pointer to the uploaded asset. This value is returned by StartContentUpload.\n
" } } } }, "com.amazonaws.wisdom#UpdateContentResponse": { "type": "structure", "members": { "content": { "target": "com.amazonaws.wisdom#ContentData", "traits": { "smithy.api#documentation": "The content.
" } } } }, "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUri": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUriRequest" }, "output": { "target": "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUriResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateUri": { "target": "com.amazonaws.wisdom#Uri", "traits": { "smithy.api#documentation": "The template URI to update.
", "smithy.api#required": {} } } } }, "com.amazonaws.wisdom#UpdateKnowledgeBaseTemplateUriResponse": { "type": "structure", "members": { "knowledgeBase": { "target": "com.amazonaws.wisdom#KnowledgeBaseData", "traits": { "smithy.api#documentation": "The knowledge base to update.
" } } } }, "com.amazonaws.wisdom#UpdateQuickResponse": { "type": "operation", "input": { "target": "com.amazonaws.wisdom#UpdateQuickResponseRequest" }, "output": { "target": "com.amazonaws.wisdom#UpdateQuickResponseResponse" }, "errors": [ { "target": "com.amazonaws.wisdom#AccessDeniedException" }, { "target": "com.amazonaws.wisdom#ConflictException" }, { "target": "com.amazonaws.wisdom#PreconditionFailedException" }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" }, { "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing Wisdom quick response.
", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}", "method": "POST" } } }, "com.amazonaws.wisdom#UpdateQuickResponseRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge \nbase if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "quickResponseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { "smithy.api#documentation": "The identifier of the quick response.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.wisdom#QuickResponseName", "traits": { "smithy.api#documentation": "The name of the quick response.
" } }, "content": { "target": "com.amazonaws.wisdom#QuickResponseDataProvider", "traits": { "smithy.api#documentation": "The updated content of the quick response.
" } }, "contentType": { "target": "com.amazonaws.wisdom#QuickResponseType", "traits": { "smithy.api#documentation": "The media type of the quick response content.
\nUse application/x.quickresponse;format=plain for quick response written in plain text.
Use application/x.quickresponse;format=markdown for quick response written in richtext.
The updated grouping configuration of the quick response.
" } }, "removeGroupingConfiguration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to remove the grouping configuration of the quick response.
" } }, "description": { "target": "com.amazonaws.wisdom#QuickResponseDescription", "traits": { "smithy.api#documentation": "The updated description of the quick response.
" } }, "removeDescription": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to remove the description from the quick response.
" } }, "shortcutKey": { "target": "com.amazonaws.wisdom#ShortCutKey", "traits": { "smithy.api#documentation": "The shortcut key of the quick response. The value should be unique across the\n knowledge base.
" } }, "removeShortcutKey": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether to remove the shortcut key of the quick response.
" } }, "isActive": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the quick response is active.
" } }, "channels": { "target": "com.amazonaws.wisdom#Channels", "traits": { "smithy.api#documentation": "The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES,\n fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR,\n zh_CN, zh_TW\n
The quick response.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wisdom#UploadId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1200 } } }, "com.amazonaws.wisdom#Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.wisdom#Url": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#Uuid": { "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}$" } }, "com.amazonaws.wisdom#UuidOrArn": { "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}$|^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})?$" } }, "com.amazonaws.wisdom#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by a service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.wisdom#WaitTimeSeconds": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 20 } } }, "com.amazonaws.wisdom#WisdomService": { "type": "service", "version": "2020-10-19", "operations": [ { "target": "com.amazonaws.wisdom#ListTagsForResource" }, { "target": "com.amazonaws.wisdom#TagResource" }, { "target": "com.amazonaws.wisdom#UntagResource" } ], "resources": [ { "target": "com.amazonaws.wisdom#Assistant" }, { "target": "com.amazonaws.wisdom#KnowledgeBase" } ], "traits": { "aws.api#service": { "sdkId": "Wisdom", "arnNamespace": "wisdom", "cloudFormationName": "Wisdom" }, "aws.auth#sigv4": { "name": "wisdom" }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're\n actively speaking with customers. Agents can search across connected repositories from within\n their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a\n knowledge base, for example, or manage content by uploading custom files.
", "smithy.api#title": "Amazon Connect Wisdom Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wisdom-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wisdom-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wisdom.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://wisdom.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wisdom.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wisdom.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } } } }