# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::ConnectWisdomService module Types # You do not have sufficient access to perform this action. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Configuration information for Amazon AppIntegrations to automatically # ingest content. # # @!attribute [rw] app_integration_arn # The Amazon Resource Name (ARN) of the AppIntegrations # DataIntegration to use for ingesting content. # # * For [ Salesforce][1], your AppIntegrations DataIntegration must # have an ObjectConfiguration if objectFields is not provided, # including at least `Id`, `ArticleNumber`, `VersionNumber`, # `Title`, `PublishStatus`, and `IsDeleted` as source fields. # # * For [ ServiceNow][2], your AppIntegrations DataIntegration must # have an ObjectConfiguration if objectFields is not provided, # including at least `number`, `short_description`, `sys_mod_count`, # `workflow_state`, and `active` as source fields. # # * For [ Zendesk][3], your AppIntegrations DataIntegration must have # an ObjectConfiguration if `objectFields` is not provided, # including at least `id`, `title`, `updated_at`, and `draft` as # source fields. # # * For [SharePoint][4], your AppIntegrations DataIntegration must # have a FileConfiguration, including only file extensions that are # among `docx`, `pdf`, `html`, `htm`, and `txt`. # # * For [Amazon S3][5], the ObjectConfiguration and FileConfiguration # of your AppIntegrations DataIntegration must be null. The # `SourceURI` of your DataIntegration must use the following format: # `s3://your_s3_bucket_name`. # # The bucket policy of the corresponding S3 bucket must allow the # Amazon Web Services principal `app-integrations.amazonaws.com` to # perform `s3:ListBucket`, `s3:GetObject`, and # `s3:GetBucketLocation` against the bucket. # # # # [1]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm # [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api # [3]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ # [4]: https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index # [5]: https://aws.amazon.com/s3/ # @return [String] # # @!attribute [rw] object_fields # The fields from the source that are made available to your agents in # Wisdom. Optional if ObjectConfiguration is included in the provided # DataIntegration. # # * For [ Salesforce][1], you must include at least `Id`, # `ArticleNumber`, `VersionNumber`, `Title`, `PublishStatus`, and # `IsDeleted`. # # * For [ ServiceNow][2], you must include at least `number`, # `short_description`, `sys_mod_count`, `workflow_state`, and # `active`. # # * For [ Zendesk][3], you must include at least `id`, `title`, # `updated_at`, and `draft`. # # Make sure to include additional fields. These fields are indexed and # used to source recommendations. # # # # [1]: https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm # [2]: https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api # [3]: https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/ # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AppIntegrationsConfiguration AWS API Documentation # class AppIntegrationsConfiguration < Struct.new( :app_integration_arn, :object_fields) SENSITIVE = [] include Aws::Structure end # Information about the assistant association. # # @!attribute [rw] assistant_arn # The Amazon Resource Name (ARN) of the Wisdom assistant. # @return [String] # # @!attribute [rw] assistant_association_arn # The Amazon Resource Name (ARN) of the assistant association. # @return [String] # # @!attribute [rw] assistant_association_id # The identifier of the assistant association. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. # @return [String] # # @!attribute [rw] association_data # A union type that currently has a single argument, the knowledge # base ID. # @return [Types::AssistantAssociationOutputData] # # @!attribute [rw] association_type # The type of association. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationData AWS API Documentation # class AssistantAssociationData < Struct.new( :assistant_arn, :assistant_association_arn, :assistant_association_id, :assistant_id, :association_data, :association_type, :tags) SENSITIVE = [] include Aws::Structure end # The data that is input into Wisdom as a result of the assistant # association. # # @note AssistantAssociationInputData is a union - when making an API calls you must set exactly one of the members. # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationInputData AWS API Documentation # class AssistantAssociationInputData < Struct.new( :knowledge_base_id, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class KnowledgeBaseId < AssistantAssociationInputData; end class Unknown < AssistantAssociationInputData; end end # The data that is output as a result of the assistant association. # # @note AssistantAssociationOutputData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AssistantAssociationOutputData corresponding to the set member. # # @!attribute [rw] knowledge_base_association # The knowledge base where output data is sent. # @return [Types::KnowledgeBaseAssociationData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationOutputData AWS API Documentation # class AssistantAssociationOutputData < Struct.new( :knowledge_base_association, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class KnowledgeBaseAssociation < AssistantAssociationOutputData; end class Unknown < AssistantAssociationOutputData; end end # Summary information about the assistant association. # # @!attribute [rw] assistant_arn # The Amazon Resource Name (ARN) of the Wisdom assistant. # @return [String] # # @!attribute [rw] assistant_association_arn # The Amazon Resource Name (ARN) of the assistant association. # @return [String] # # @!attribute [rw] assistant_association_id # The identifier of the assistant association. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. # @return [String] # # @!attribute [rw] association_data # The association data. # @return [Types::AssistantAssociationOutputData] # # @!attribute [rw] association_type # The type of association. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantAssociationSummary AWS API Documentation # class AssistantAssociationSummary < Struct.new( :assistant_arn, :assistant_association_arn, :assistant_association_id, :assistant_id, :association_data, :association_type, :tags) SENSITIVE = [] include Aws::Structure end # The assistant data. # # @!attribute [rw] assistant_arn # The Amazon Resource Name (ARN) of the Wisdom assistant. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. # @return [String] # # @!attribute [rw] description # The description. # @return [String] # # @!attribute [rw] integration_configuration # The configuration information for the Wisdom assistant integration. # @return [Types::AssistantIntegrationConfiguration] # # @!attribute [rw] name # The name. # @return [String] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # This KMS key must have a policy that allows `kms:CreateGrant`, # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions # to the IAM identity using the key to invoke Wisdom. To use Wisdom # with chat, the key policy must also allow `kms:Decrypt`, # `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the # `connect.amazonaws.com` service principal. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] status # The status of the assistant. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] type # The type of assistant. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantData AWS API Documentation # class AssistantData < Struct.new( :assistant_arn, :assistant_id, :description, :integration_configuration, :name, :server_side_encryption_configuration, :status, :tags, :type) SENSITIVE = [] include Aws::Structure end # The configuration information for the Wisdom assistant integration. # # @!attribute [rw] topic_integration_arn # The Amazon Resource Name (ARN) of the integrated Amazon SNS topic # used for streaming chat messages. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantIntegrationConfiguration AWS API Documentation # class AssistantIntegrationConfiguration < Struct.new( :topic_integration_arn) SENSITIVE = [] include Aws::Structure end # Summary information about the assistant. # # @!attribute [rw] assistant_arn # The Amazon Resource Name (ARN) of the Wisdom assistant. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. # @return [String] # # @!attribute [rw] description # The description of the assistant. # @return [String] # # @!attribute [rw] integration_configuration # The configuration information for the Wisdom assistant integration. # @return [Types::AssistantIntegrationConfiguration] # # @!attribute [rw] name # The name of the assistant. # @return [String] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # This KMS key must have a policy that allows `kms:CreateGrant`, # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions # to the IAM identity using the key to invoke Wisdom. To use Wisdom # with chat, the key policy must also allow `kms:Decrypt`, # `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the # `connect.amazonaws.com` service principal. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] status # The status of the assistant. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] type # The type of the assistant. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/AssistantSummary AWS API Documentation # class AssistantSummary < Struct.new( :assistant_arn, :assistant_id, :description, :integration_configuration, :name, :server_side_encryption_configuration, :status, :tags, :type) SENSITIVE = [] include Aws::Structure end # The configuration information of the external data source. # # @note Configuration is a union - when making an API calls you must set exactly one of the members. # # @note Configuration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Configuration corresponding to the set member. # # @!attribute [rw] connect_configuration # The configuration information of the Amazon Connect data source. # @return [Types::ConnectConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Configuration AWS API Documentation # class Configuration < Struct.new( :connect_configuration, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class ConnectConfiguration < Configuration; end class Unknown < Configuration; end end # The request could not be processed because of conflict in the current # state of the resource. For example, if you're using a `Create` API # (such as `CreateAssistant`) that accepts name, a conflicting resource # (usually with the same name) is being created or mutated. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The configuration information of the Amazon Connect data source. # # @!attribute [rw] instance_id # The identifier of the Amazon Connect instance. You can find the # instanceId in the ARN of the instance. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ConnectConfiguration AWS API Documentation # class ConnectConfiguration < Struct.new( :instance_id) SENSITIVE = [] include Aws::Structure end # Information about the content. # # @!attribute [rw] content_arn # The Amazon Resource Name (ARN) of the content. # @return [String] # # @!attribute [rw] content_id # The identifier of the content. # @return [String] # # @!attribute [rw] content_type # The media type of the content. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] link_out_uri # The URI of the content. # @return [String] # # @!attribute [rw] metadata # A key/value map to store attributes without affecting tagging or # recommendations. For example, when synchronizing data between an # external system and Wisdom, you can store an external version # identifier as metadata to utilize for determining drift. # @return [Hash] # # @!attribute [rw] name # The name of the content. # @return [String] # # @!attribute [rw] revision_id # The identifier of the content revision. # @return [String] # # @!attribute [rw] status # The status of the content. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] title # The title of the content. # @return [String] # # @!attribute [rw] url # The URL of the content. # @return [String] # # @!attribute [rw] url_expiry # The expiration time of the URL as an epoch timestamp. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentData AWS API Documentation # class ContentData < Struct.new( :content_arn, :content_id, :content_type, :knowledge_base_arn, :knowledge_base_id, :link_out_uri, :metadata, :name, :revision_id, :status, :tags, :title, :url, :url_expiry) SENSITIVE = [:url] include Aws::Structure end # Reference information about the content. # # @!attribute [rw] content_arn # The Amazon Resource Name (ARN) of the content. # @return [String] # # @!attribute [rw] content_id # The identifier of the content. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentReference AWS API Documentation # class ContentReference < Struct.new( :content_arn, :content_id, :knowledge_base_arn, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # Summary information about the content. # # @!attribute [rw] content_arn # The Amazon Resource Name (ARN) of the content. # @return [String] # # @!attribute [rw] content_id # The identifier of the content. # @return [String] # # @!attribute [rw] content_type # The media type of the content. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] metadata # A key/value map to store attributes without affecting tagging or # recommendations. For example, when synchronizing data between an # external system and Wisdom, you can store an external version # identifier as metadata to utilize for determining drift. # @return [Hash] # # @!attribute [rw] name # The name of the content. # @return [String] # # @!attribute [rw] revision_id # The identifier of the revision of the content. # @return [String] # # @!attribute [rw] status # The status of the content. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] title # The title of the content. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ContentSummary AWS API Documentation # class ContentSummary < Struct.new( :content_arn, :content_id, :content_type, :knowledge_base_arn, :knowledge_base_id, :metadata, :name, :revision_id, :status, :tags, :title) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] association # The identifier of the associated resource. # @return [Types::AssistantAssociationInputData] # # @!attribute [rw] association_type # The type of association. # @return [String] # # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociationRequest AWS API Documentation # class CreateAssistantAssociationRequest < Struct.new( :assistant_id, :association, :association_type, :client_token, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_association # The assistant association. # @return [Types::AssistantAssociationData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociationResponse AWS API Documentation # class CreateAssistantAssociationResponse < Struct.new( :assistant_association) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] description # The description of the assistant. # @return [String] # # @!attribute [rw] name # The name of the assistant. # @return [String] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # The customer managed key must have a policy that allows # `kms:CreateGrant`, ` kms:DescribeKey`, and # `kms:Decrypt/kms:GenerateDataKey` permissions to the IAM identity # using the key to invoke Wisdom. To use Wisdom with chat, the key # policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and # `kms:DescribeKey` permissions to the `connect.amazonaws.com` service # principal. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] type # The type of assistant. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantRequest AWS API Documentation # class CreateAssistantRequest < Struct.new( :client_token, :description, :name, :server_side_encryption_configuration, :tags, :type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant # Information about the assistant. # @return [Types::AssistantData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantResponse AWS API Documentation # class CreateAssistantResponse < Struct.new( :assistant) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] metadata # A key/value map to store attributes without affecting tagging or # recommendations. For example, when synchronizing data between an # external system and Wisdom, you can store an external version # identifier as metadata to utilize for determining drift. # @return [Hash] # # @!attribute [rw] name # The name of the content. Each piece of content in a knowledge base # must have a unique name. You can retrieve a piece of content using # only its knowledge base and its name with the [SearchContent][1] # API. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html # @return [String] # # @!attribute [rw] override_link_out_uri # The URI you want to use for the article. If the knowledge base has a # templateUri, setting this argument overrides it for this piece of # content. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @!attribute [rw] title # The title of the content. If not set, the title is equal to the # name. # @return [String] # # @!attribute [rw] upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContentRequest AWS API Documentation # class CreateContentRequest < Struct.new( :client_token, :knowledge_base_id, :metadata, :name, :override_link_out_uri, :tags, :title, :upload_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content # The content. # @return [Types::ContentData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContentResponse AWS API Documentation # class CreateContentResponse < Struct.new( :content) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] description # The description. # @return [String] # # @!attribute [rw] knowledge_base_type # The type of knowledge base. Only CUSTOM knowledge bases allow you to # upload your own content. EXTERNAL knowledge bases support # integrations with third-party systems whose content is synchronized # automatically. # @return [String] # # @!attribute [rw] name # The name of the knowledge base. # @return [String] # # @!attribute [rw] rendering_configuration # Information about how to render the content. # @return [Types::RenderingConfiguration] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # This KMS key must have a policy that allows `kms:CreateGrant`, # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions # to the IAM identity using the key to invoke Wisdom. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] source_configuration # The source of the knowledge base content. Only set this argument for # EXTERNAL knowledge bases. # @return [Types::SourceConfiguration] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBaseRequest AWS API Documentation # class CreateKnowledgeBaseRequest < Struct.new( :client_token, :description, :knowledge_base_type, :name, :rendering_configuration, :server_side_encryption_configuration, :source_configuration, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base # The knowledge base. # @return [Types::KnowledgeBaseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBaseResponse AWS API Documentation # class CreateKnowledgeBaseResponse < Struct.new( :knowledge_base) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] channels # The Amazon Connect channels this quick response applies to. # @return [Array] # # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] content # The content of the quick response. # @return [Types::QuickResponseDataProvider] # # @!attribute [rw] content_type # The media type of the quick response content. # # * Use `application/x.quickresponse;format=plain` for a quick # response written in plain text. # # * Use `application/x.quickresponse;format=markdown` for a quick # response written in richtext. # @return [String] # # @!attribute [rw] description # The description of the quick response. # @return [String] # # @!attribute [rw] grouping_configuration # The configuration information of the user groups that the quick # response is accessible to. # @return [Types::GroupingConfiguration] # # @!attribute [rw] is_active # Whether the quick response is active. # @return [Boolean] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] language # The language code value for the language in which the quick response # is written. The supported language codes include `de_DE`, `en_US`, # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, # `zh_CN`, `zh_TW` # @return [String] # # @!attribute [rw] name # The name of the quick response. # @return [String] # # @!attribute [rw] shortcut_key # The shortcut key of the quick response. The value should be unique # across the knowledge base. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateQuickResponseRequest AWS API Documentation # class CreateQuickResponseRequest < Struct.new( :channels, :client_token, :content, :content_type, :description, :grouping_configuration, :is_active, :knowledge_base_id, :language, :name, :shortcut_key, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] quick_response # The quick response. # @return [Types::QuickResponseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateQuickResponseResponse AWS API Documentation # class CreateQuickResponseResponse < Struct.new( :quick_response) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] client_token # A unique, case-sensitive identifier that you provide to ensure the # idempotency of the request. If not provided, the Amazon Web Services # SDK populates this field. For more information about idempotency, # see [Making retries safe with idempotent APIs][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/ # @return [String] # # @!attribute [rw] description # The description. # @return [String] # # @!attribute [rw] name # The name of the session. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSessionRequest AWS API Documentation # class CreateSessionRequest < Struct.new( :assistant_id, :client_token, :description, :name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] session # The session. # @return [Types::SessionData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSessionResponse AWS API Documentation # class CreateSessionResponse < Struct.new( :session) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_association_id # The identifier of the assistant association. Can be either the ID or # the ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociationRequest AWS API Documentation # class DeleteAssistantAssociationRequest < Struct.new( :assistant_association_id, :assistant_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociationResponse AWS API Documentation # class DeleteAssistantAssociationResponse < Aws::EmptyStructure; end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantRequest AWS API Documentation # class DeleteAssistantRequest < Struct.new( :assistant_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantResponse AWS API Documentation # class DeleteAssistantResponse < Aws::EmptyStructure; end # @!attribute [rw] content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContentRequest AWS API Documentation # class DeleteContentRequest < Struct.new( :content_id, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContentResponse AWS API Documentation # class DeleteContentResponse < Aws::EmptyStructure; end # @!attribute [rw] import_job_id # The identifier of the import job to be deleted. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteImportJobRequest AWS API Documentation # class DeleteImportJobRequest < Struct.new( :import_job_id, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteImportJobResponse AWS API Documentation # class DeleteImportJobResponse < Aws::EmptyStructure; end # @!attribute [rw] knowledge_base_id # The knowledge base to delete content from. Can be either the ID or # the ARN. URLs cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBaseRequest AWS API Documentation # class DeleteKnowledgeBaseRequest < Struct.new( :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBaseResponse AWS API Documentation # class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end # @!attribute [rw] knowledge_base_id # 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 base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteQuickResponseRequest AWS API Documentation # class DeleteQuickResponseRequest < Struct.new( :knowledge_base_id, :quick_response_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteQuickResponseResponse AWS API Documentation # class DeleteQuickResponseResponse < Aws::EmptyStructure; end # The document. # # @!attribute [rw] content_reference # A reference to the content resource. # @return [Types::ContentReference] # # @!attribute [rw] excerpt # The excerpt from the document. # @return [Types::DocumentText] # # @!attribute [rw] title # The title of the document. # @return [Types::DocumentText] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Document AWS API Documentation # class Document < Struct.new( :content_reference, :excerpt, :title) SENSITIVE = [] include Aws::Structure end # The text of the document. # # @!attribute [rw] highlights # Highlights in the document text. # @return [Array] # # @!attribute [rw] text # Text in the document. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DocumentText AWS API Documentation # class DocumentText < Struct.new( :highlights, :text) SENSITIVE = [:text] include Aws::Structure end # The configuration information of the external data source. # # @!attribute [rw] configuration # The configuration information of the external data source. # @return [Types::Configuration] # # @!attribute [rw] source # The type of the external data source. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ExternalSourceConfiguration AWS API Documentation # class ExternalSourceConfiguration < Struct.new( :configuration, :source) SENSITIVE = [] include Aws::Structure end # A search filter. # # @!attribute [rw] field # The field on which to filter. # @return [String] # # @!attribute [rw] operator # The operator to use for comparing the field’s value with the # provided value. # @return [String] # # @!attribute [rw] value # The desired field value on which to filter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Filter AWS API Documentation # class Filter < Struct.new( :field, :operator, :value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_association_id # The identifier of the assistant association. Can be either the ID or # the ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociationRequest AWS API Documentation # class GetAssistantAssociationRequest < Struct.new( :assistant_association_id, :assistant_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_association # The assistant association. # @return [Types::AssistantAssociationData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociationResponse AWS API Documentation # class GetAssistantAssociationResponse < Struct.new( :assistant_association) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantRequest AWS API Documentation # class GetAssistantRequest < Struct.new( :assistant_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant # Information about the assistant. # @return [Types::AssistantData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantResponse AWS API Documentation # class GetAssistantResponse < Struct.new( :assistant) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentRequest AWS API Documentation # class GetContentRequest < Struct.new( :content_id, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content # The content. # @return [Types::ContentData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentResponse AWS API Documentation # class GetContentResponse < Struct.new( :content) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummaryRequest AWS API Documentation # class GetContentSummaryRequest < Struct.new( :content_id, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content_summary # The content summary. # @return [Types::ContentSummary] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummaryResponse AWS API Documentation # class GetContentSummaryResponse < Struct.new( :content_summary) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_job_id # The identifier of the import job to retrieve. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base that the import job belongs to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetImportJobRequest AWS API Documentation # class GetImportJobRequest < Struct.new( :import_job_id, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_job # The import job. # @return [Types::ImportJobData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetImportJobResponse AWS API Documentation # class GetImportJobResponse < Struct.new( :import_job) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBaseRequest AWS API Documentation # class GetKnowledgeBaseRequest < Struct.new( :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base # The knowledge base. # @return [Types::KnowledgeBaseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBaseResponse AWS API Documentation # class GetKnowledgeBaseResponse < Struct.new( :knowledge_base) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should be a # QUICK\_RESPONSES type knowledge base. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetQuickResponseRequest AWS API Documentation # class GetQuickResponseRequest < Struct.new( :knowledge_base_id, :quick_response_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] quick_response # The quick response. # @return [Types::QuickResponseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetQuickResponseResponse AWS API Documentation # class GetQuickResponseResponse < Struct.new( :quick_response) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] session_id # The identifier of the session. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @!attribute [rw] wait_time_seconds # The duration (in seconds) for which the call waits for a # recommendation to be made available before returning. If a # recommendation is available, the call returns sooner than # `WaitTimeSeconds`. If no messages are available and the wait time # expires, the call returns successfully with an empty list. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendationsRequest AWS API Documentation # class GetRecommendationsRequest < Struct.new( :assistant_id, :max_results, :session_id, :wait_time_seconds) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] recommendations # The recommendations. # @return [Array] # # @!attribute [rw] triggers # The triggers corresponding to recommendations. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendationsResponse AWS API Documentation # class GetRecommendationsResponse < Struct.new( :recommendations, :triggers) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] session_id # The identifier of the session. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSessionRequest AWS API Documentation # class GetSessionRequest < Struct.new( :assistant_id, :session_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] session # The session. # @return [Types::SessionData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSessionResponse AWS API Documentation # class GetSessionResponse < Struct.new( :session) SENSITIVE = [] include Aws::Structure end # The configuration information of the grouping of Wisdom users. # # @!attribute [rw] criteria # The criteria used for grouping Wisdom users. # # The following is the list of supported criteria values. # # * `RoutingProfileArn`: Grouping the users by their [Amazon Connect # routing profile ARN][1]. User should have # [SearchRoutingProfile][2] and [DescribeRoutingProfile][3] # permissions when setting criteria to this value. # # ^ # # # # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html # @return [String] # # @!attribute [rw] values # The list of values that define different groups of Wisdom users. # # * When setting `criteria` to `RoutingProfileArn`, you need to # provide a list of ARNs of [Amazon Connect routing profiles][1] as # values of this parameter. # # ^ # # # # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GroupingConfiguration AWS API Documentation # class GroupingConfiguration < Struct.new( :criteria, :values) SENSITIVE = [:criteria] include Aws::Structure end # Offset specification to describe highlighting of document excerpts for # rendering search results and recommendations. # # @!attribute [rw] begin_offset_inclusive # The offset for the start of the highlight. # @return [Integer] # # @!attribute [rw] end_offset_exclusive # The offset for the end of the highlight. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/Highlight AWS API Documentation # class Highlight < Struct.new( :begin_offset_inclusive, :end_offset_exclusive) SENSITIVE = [] include Aws::Structure end # Summary information about the import job. # # @!attribute [rw] created_time # The timestamp when the import job was created. # @return [Time] # # @!attribute [rw] external_source_configuration # The configuration information of the external data source. # @return [Types::ExternalSourceConfiguration] # # @!attribute [rw] failed_record_report # The link to donwload the information of resource data that failed to # be imported. # @return [String] # # @!attribute [rw] import_job_id # The identifier of the import job. # @return [String] # # @!attribute [rw] import_job_type # The type of the import job. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] last_modified_time # The timestamp when the import job data was last modified. # @return [Time] # # @!attribute [rw] metadata # The metadata fields of the imported Wisdom resources. # @return [Hash] # # @!attribute [rw] status # The status of the import job. # @return [String] # # @!attribute [rw] upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html # @return [String] # # @!attribute [rw] url # The download link to the resource file that is uploaded to the # import job. # @return [String] # # @!attribute [rw] url_expiry # The expiration time of the URL as an epoch timestamp. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ImportJobData AWS API Documentation # class ImportJobData < Struct.new( :created_time, :external_source_configuration, :failed_record_report, :import_job_id, :import_job_type, :knowledge_base_arn, :knowledge_base_id, :last_modified_time, :metadata, :status, :upload_id, :url, :url_expiry) SENSITIVE = [:failed_record_report, :url] include Aws::Structure end # Summary information about the import job. # # @!attribute [rw] created_time # The timestamp when the import job was created. # @return [Time] # # @!attribute [rw] external_source_configuration # The configuration information of the external source that the # resource data are imported from. # @return [Types::ExternalSourceConfiguration] # # @!attribute [rw] import_job_id # The identifier of the import job. # @return [String] # # @!attribute [rw] import_job_type # The type of import job. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] last_modified_time # The timestamp when the import job was last modified. # @return [Time] # # @!attribute [rw] metadata # The metadata fields of the imported Wisdom resources. # @return [Hash] # # @!attribute [rw] status # The status of the import job. # @return [String] # # @!attribute [rw] upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ImportJobSummary AWS API Documentation # class ImportJobSummary < Struct.new( :created_time, :external_source_configuration, :import_job_id, :import_job_type, :knowledge_base_arn, :knowledge_base_id, :last_modified_time, :metadata, :status, :upload_id) SENSITIVE = [] include Aws::Structure end # Association information about the knowledge base. # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseAssociationData AWS API Documentation # class KnowledgeBaseAssociationData < Struct.new( :knowledge_base_arn, :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # Information about the knowledge base. # # @!attribute [rw] description # The description. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] knowledge_base_type # The type of knowledge base. # @return [String] # # @!attribute [rw] last_content_modification_time # An epoch timestamp indicating the most recent content modification # inside the knowledge base. If no content exists in a knowledge base, # this value is unset. # @return [Time] # # @!attribute [rw] name # The name of the knowledge base. # @return [String] # # @!attribute [rw] rendering_configuration # Information about how to render the content. # @return [Types::RenderingConfiguration] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # This KMS key must have a policy that allows `kms:CreateGrant`, # `kms:DescribeKey`, and `kms:Decrypt/kms:GenerateDataKey` permissions # to the IAM identity using the key to invoke Wisdom. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] source_configuration # Source configuration information about the knowledge base. # @return [Types::SourceConfiguration] # # @!attribute [rw] status # The status of the knowledge base. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseData AWS API Documentation # class KnowledgeBaseData < Struct.new( :description, :knowledge_base_arn, :knowledge_base_id, :knowledge_base_type, :last_content_modification_time, :name, :rendering_configuration, :server_side_encryption_configuration, :source_configuration, :status, :tags) SENSITIVE = [] include Aws::Structure end # Summary information about the knowledge base. # # @!attribute [rw] description # The description of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] knowledge_base_type # The type of knowledge base. # @return [String] # # @!attribute [rw] name # The name of the knowledge base. # @return [String] # # @!attribute [rw] rendering_configuration # Information about how to render the content. # @return [Types::RenderingConfiguration] # # @!attribute [rw] server_side_encryption_configuration # The configuration information for the customer managed key used for # encryption. # # This KMS key must have a policy that allows `kms:CreateGrant`, # `kms:DescribeKey`, `kms:Decrypt/kms:GenerateDataKey` permissions to # the IAM identity using the key to invoke Wisdom. # # For more information about setting up a customer managed key for # Wisdom, see [Enable Amazon Connect Wisdom for your instance][1]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # @return [Types::ServerSideEncryptionConfiguration] # # @!attribute [rw] source_configuration # Configuration information about the external data source. # @return [Types::SourceConfiguration] # # @!attribute [rw] status # The status of the knowledge base summary. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/KnowledgeBaseSummary AWS API Documentation # class KnowledgeBaseSummary < Struct.new( :description, :knowledge_base_arn, :knowledge_base_id, :knowledge_base_type, :name, :rendering_configuration, :server_side_encryption_configuration, :source_configuration, :status, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociationsRequest AWS API Documentation # class ListAssistantAssociationsRequest < Struct.new( :assistant_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_association_summaries # Summary information about assistant associations. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociationsResponse AWS API Documentation # class ListAssistantAssociationsResponse < Struct.new( :assistant_association_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantsRequest AWS API Documentation # class ListAssistantsRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_summaries # Information about the assistants. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantsResponse AWS API Documentation # class ListAssistantsResponse < Struct.new( :assistant_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContentsRequest AWS API Documentation # class ListContentsRequest < Struct.new( :knowledge_base_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content_summaries # Information about the content. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContentsResponse AWS API Documentation # class ListContentsResponse < Struct.new( :content_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListImportJobsRequest AWS API Documentation # class ListImportJobsRequest < Struct.new( :knowledge_base_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_job_summaries # Summary information about the import jobs. # @return [Array] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListImportJobsResponse AWS API Documentation # class ListImportJobsResponse < Struct.new( :import_job_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBasesRequest AWS API Documentation # class ListKnowledgeBasesRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_summaries # Information about the knowledge bases. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBasesResponse AWS API Documentation # class ListKnowledgeBasesResponse < Struct.new( :knowledge_base_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListQuickResponsesRequest AWS API Documentation # class ListQuickResponsesRequest < Struct.new( :knowledge_base_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] quick_response_summaries # Summary information about the quick responses. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListQuickResponsesResponse AWS API Documentation # class ListQuickResponsesResponse < Struct.new( :next_token, :quick_response_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) SENSITIVE = [] include Aws::Structure end # An error occurred when creating a recommendation. # # @!attribute [rw] message # A recommendation is causing an error. # @return [String] # # @!attribute [rw] recommendation_id # The identifier of the recommendation that is in error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedError AWS API Documentation # class NotifyRecommendationsReceivedError < Struct.new( :message, :recommendation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] recommendation_ids # The identifiers of the recommendations. # @return [Array] # # @!attribute [rw] session_id # The identifier of the session. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedRequest AWS API Documentation # class NotifyRecommendationsReceivedRequest < Struct.new( :assistant_id, :recommendation_ids, :session_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] errors # The identifiers of recommendations that are causing errors. # @return [Array] # # @!attribute [rw] recommendation_ids # The identifiers of the recommendations. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceivedResponse AWS API Documentation # class NotifyRecommendationsReceivedResponse < Struct.new( :errors, :recommendation_ids) SENSITIVE = [] include Aws::Structure end # The provided `revisionId` does not match, indicating the content has # been modified since it was last read. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PreconditionFailedException AWS API Documentation # class PreconditionFailedException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] query_text # The text to search for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantRequest AWS API Documentation # class QueryAssistantRequest < Struct.new( :assistant_id, :max_results, :next_token, :query_text) SENSITIVE = [:query_text] include Aws::Structure end # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @!attribute [rw] results # The results of the query. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistantResponse AWS API Documentation # class QueryAssistantResponse < Struct.new( :next_token, :results) SENSITIVE = [] include Aws::Structure end # Data associated with the QUERY RecommendationTriggerType. # # @!attribute [rw] text # The text associated with the recommendation trigger. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryRecommendationTriggerData AWS API Documentation # class QueryRecommendationTriggerData < Struct.new( :text) SENSITIVE = [:text] include Aws::Structure end # The container quick response content. # # @note QuickResponseContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of QuickResponseContentProvider corresponding to the set member. # # @!attribute [rw] content # The content of the quick response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseContentProvider AWS API Documentation # class QuickResponseContentProvider < Struct.new( :content, :unknown) SENSITIVE = [:content] include Aws::Structure include Aws::Structure::Union class Content < QuickResponseContentProvider; end class Unknown < QuickResponseContentProvider; end end # The content of the quick response stored in different media types. # # @!attribute [rw] markdown # The container quick response content. # @return [Types::QuickResponseContentProvider] # # @!attribute [rw] plain_text # The container quick response content. # @return [Types::QuickResponseContentProvider] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseContents AWS API Documentation # class QuickResponseContents < Struct.new( :markdown, :plain_text) SENSITIVE = [] include Aws::Structure end # Information about the quick response. # # @!attribute [rw] channels # The Amazon Connect contact channels this quick response applies to. # The supported contact channel types include `Chat`. # @return [Array] # # @!attribute [rw] content_type # The media type of the quick response content. # # * Use `application/x.quickresponse;format=plain` for quick response # written in plain text. # # * Use `application/x.quickresponse;format=markdown` for quick # response written in richtext. # @return [String] # # @!attribute [rw] contents # The contents of the quick response. # @return [Types::QuickResponseContents] # # @!attribute [rw] created_time # The timestamp when the quick response was created. # @return [Time] # # @!attribute [rw] description # The description of the quick response. # @return [String] # # @!attribute [rw] grouping_configuration # The configuration information of the user groups that the quick # response is accessible to. # @return [Types::GroupingConfiguration] # # @!attribute [rw] is_active # Whether the quick response is active. # @return [Boolean] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] language # The language code value for the language in which the quick response # is written. # @return [String] # # @!attribute [rw] last_modified_by # The Amazon Resource Name (ARN) of the user who last updated the # quick response data. # @return [String] # # @!attribute [rw] last_modified_time # The timestamp when the quick response data was last modified. # @return [Time] # # @!attribute [rw] name # The name of the quick response. # @return [String] # # @!attribute [rw] quick_response_arn # The Amazon Resource Name (ARN) of the quick response. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response. # @return [String] # # @!attribute [rw] shortcut_key # The shortcut key of the quick response. The value should be unique # across the knowledge base. # @return [String] # # @!attribute [rw] status # The status of the quick response data. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseData AWS API Documentation # class QuickResponseData < Struct.new( :channels, :content_type, :contents, :created_time, :description, :grouping_configuration, :is_active, :knowledge_base_arn, :knowledge_base_id, :language, :last_modified_by, :last_modified_time, :name, :quick_response_arn, :quick_response_id, :shortcut_key, :status, :tags) SENSITIVE = [] include Aws::Structure end # The container of quick response data. # # @note QuickResponseDataProvider is a union - when making an API calls you must set exactly one of the members. # # @!attribute [rw] content # The content of the quick response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseDataProvider AWS API Documentation # class QuickResponseDataProvider < Struct.new( :content, :unknown) SENSITIVE = [:content] include Aws::Structure include Aws::Structure::Union class Content < QuickResponseDataProvider; end class Unknown < QuickResponseDataProvider; end end # The quick response fields to filter the quick response query results # by. # # The following is the list of supported field names. # # * name # # * description # # * shortcutKey # # * isActive # # * channels # # * language # # * contentType # # * createdTime # # * lastModifiedTime # # * lastModifiedBy # # * groupingConfiguration.criteria # # * groupingConfiguration.values # # @!attribute [rw] include_no_existence # Whether to treat null value as a match for the attribute field. # @return [Boolean] # # @!attribute [rw] name # The name of the attribute field to filter the quick responses by. # @return [String] # # @!attribute [rw] operator # The operator to use for filtering. # @return [String] # # @!attribute [rw] values # The values of attribute field to filter the quick response by. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseFilterField AWS API Documentation # class QuickResponseFilterField < Struct.new( :include_no_existence, :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # The quick response fields to order the quick response query results # by. # # The following is the list of supported field names. # # * name # # * description # # * shortcutKey # # * isActive # # * channels # # * language # # * contentType # # * createdTime # # * lastModifiedTime # # * lastModifiedBy # # * groupingConfiguration.criteria # # * groupingConfiguration.values # # @!attribute [rw] name # The name of the attribute to order the quick response query results # by. # @return [String] # # @!attribute [rw] order # The order at which the quick responses are sorted by. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseOrderField AWS API Documentation # class QuickResponseOrderField < Struct.new( :name, :order) SENSITIVE = [] include Aws::Structure end # The quick response fields to query quick responses by. # # The following is the list of supported field names. # # * content # # * name # # * description # # * shortcutKey # # @!attribute [rw] allow_fuzziness # 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. # @return [Boolean] # # @!attribute [rw] name # The name of the attribute to query the quick responses by. # @return [String] # # @!attribute [rw] operator # The operator to use for matching attribute field values in the # query. # @return [String] # # @!attribute [rw] priority # The importance of the attribute field when calculating query result # relevancy scores. The value set for this parameter affects the # ordering of search results. # @return [String] # # @!attribute [rw] values # The values of the attribute to query the quick responses by. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseQueryField AWS API Documentation # class QuickResponseQueryField < Struct.new( :allow_fuzziness, :name, :operator, :priority, :values) SENSITIVE = [] include Aws::Structure end # Information about the import job. # # @!attribute [rw] filters # The configuration of filtering rules applied to quick response query # results. # @return [Array] # # @!attribute [rw] order_on_field # The quick response attribute fields on which the query results are # ordered. # @return [Types::QuickResponseOrderField] # # @!attribute [rw] queries # The quick response query expressions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSearchExpression AWS API Documentation # class QuickResponseSearchExpression < Struct.new( :filters, :order_on_field, :queries) SENSITIVE = [] include Aws::Structure end # The result of quick response search. # # @!attribute [rw] attributes_interpolated # The user defined contact attributes that are resolved when the # search result is returned. # @return [Array] # # @!attribute [rw] attributes_not_interpolated # The user defined contact attributes that are not resolved when the # search result is returned. # @return [Array] # # @!attribute [rw] channels # The Amazon Connect contact channels this quick response applies to. # The supported contact channel types include `Chat`. # @return [Array] # # @!attribute [rw] content_type # The media type of the quick response content. # # * Use `application/x.quickresponse;format=plain` for quick response # written in plain text. # # * Use `application/x.quickresponse;format=markdown` for quick # response written in richtext. # @return [String] # # @!attribute [rw] contents # The contents of the quick response. # @return [Types::QuickResponseContents] # # @!attribute [rw] created_time # The timestamp when the quick response was created. # @return [Time] # # @!attribute [rw] description # The description of the quick response. # @return [String] # # @!attribute [rw] grouping_configuration # The configuration information of the user groups that the quick # response is accessible to. # @return [Types::GroupingConfiguration] # # @!attribute [rw] is_active # Whether the quick response is active. # @return [Boolean] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] language # The language code value for the language in which the quick response # is written. # @return [String] # # @!attribute [rw] last_modified_by # The Amazon Resource Name (ARN) of the user who last updated the # quick response search result data. # @return [String] # # @!attribute [rw] last_modified_time # The timestamp when the quick response search result data was last # modified. # @return [Time] # # @!attribute [rw] name # The name of the quick response. # @return [String] # # @!attribute [rw] quick_response_arn # The Amazon Resource Name (ARN) of the quick response. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response. # @return [String] # # @!attribute [rw] shortcut_key # The shortcut key of the quick response. The value should be unique # across the knowledge base. # @return [String] # # @!attribute [rw] status # The resource status of the quick response. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSearchResultData AWS API Documentation # class QuickResponseSearchResultData < Struct.new( :attributes_interpolated, :attributes_not_interpolated, :channels, :content_type, :contents, :created_time, :description, :grouping_configuration, :is_active, :knowledge_base_arn, :knowledge_base_id, :language, :last_modified_by, :last_modified_time, :name, :quick_response_arn, :quick_response_id, :shortcut_key, :status, :tags) SENSITIVE = [:attributes_interpolated, :attributes_not_interpolated] include Aws::Structure end # The summary information about the quick response. # # @!attribute [rw] channels # The Amazon Connect contact channels this quick response applies to. # The supported contact channel types include `Chat`. # @return [Array] # # @!attribute [rw] content_type # The media type of the quick response content. # # * Use `application/x.quickresponse;format=plain` for quick response # written in plain text. # # * Use `application/x.quickresponse;format=markdown` for quick # response written in richtext. # @return [String] # # @!attribute [rw] created_time # The timestamp when the quick response was created. # @return [Time] # # @!attribute [rw] description # The description of the quick response. # @return [String] # # @!attribute [rw] is_active # Whether the quick response is active. # @return [Boolean] # # @!attribute [rw] knowledge_base_arn # The Amazon Resource Name (ARN) of the knowledge base. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. # @return [String] # # @!attribute [rw] last_modified_by # The Amazon Resource Name (ARN) of the user who last updated the # quick response data. # @return [String] # # @!attribute [rw] last_modified_time # The timestamp when the quick response summary was last modified. # @return [Time] # # @!attribute [rw] name # The name of the quick response. # @return [String] # # @!attribute [rw] quick_response_arn # The Amazon Resource Name (ARN) of the quick response. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response. # @return [String] # # @!attribute [rw] status # The resource status of the quick response. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QuickResponseSummary AWS API Documentation # class QuickResponseSummary < Struct.new( :channels, :content_type, :created_time, :description, :is_active, :knowledge_base_arn, :knowledge_base_id, :last_modified_by, :last_modified_time, :name, :quick_response_arn, :quick_response_id, :status, :tags) SENSITIVE = [] include Aws::Structure end # Information about the recommendation. # # @!attribute [rw] document # The recommended document. # @return [Types::Document] # # @!attribute [rw] recommendation_id # The identifier of the recommendation. # @return [String] # # @!attribute [rw] relevance_level # The relevance level of the recommendation. # @return [String] # # @!attribute [rw] relevance_score # The relevance score of the recommendation. # @return [Float] # # @!attribute [rw] type # The type of recommendation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RecommendationData AWS API Documentation # class RecommendationData < Struct.new( :document, :recommendation_id, :relevance_level, :relevance_score, :type) SENSITIVE = [] include Aws::Structure end # A recommendation trigger provides context on the event that produced # the referenced recommendations. Recommendations are only referenced in # `recommendationIds` by a single RecommendationTrigger. # # @!attribute [rw] data # A union type containing information related to the trigger. # @return [Types::RecommendationTriggerData] # # @!attribute [rw] id # The identifier of the recommendation trigger. # @return [String] # # @!attribute [rw] recommendation_ids # The identifiers of the recommendations. # @return [Array] # # @!attribute [rw] source # The source of the recommendation trigger. # # * ISSUE\_DETECTION: The corresponding recommendations were triggered # by a Contact Lens issue. # # * RULE\_EVALUATION: The corresponding recommendations were triggered # by a Contact Lens rule. # @return [String] # # @!attribute [rw] type # The type of recommendation trigger. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RecommendationTrigger AWS API Documentation # class RecommendationTrigger < Struct.new( :data, :id, :recommendation_ids, :source, :type) SENSITIVE = [] include Aws::Structure end # A union type containing information related to the trigger. # # @note RecommendationTriggerData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RecommendationTriggerData corresponding to the set member. # # @!attribute [rw] query # Data associated with the QUERY RecommendationTriggerType. # @return [Types::QueryRecommendationTriggerData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RecommendationTriggerData AWS API Documentation # class RecommendationTriggerData < Struct.new( :query, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Query < RecommendationTriggerData; end class Unknown < RecommendationTriggerData; end end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUriRequest AWS API Documentation # class RemoveKnowledgeBaseTemplateUriRequest < Struct.new( :knowledge_base_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUriResponse AWS API Documentation # class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure; end # Information about how to render the content. # # @!attribute [rw] template_uri # A URI template containing exactly one variable in `$\{variableName\} # `format. This can only be set for `EXTERNAL` knowledge bases. For # Salesforce, ServiceNow, and Zendesk, the variable must be one of the # following: # # * Salesforce: `Id`, `ArticleNumber`, `VersionNumber`, `Title`, # `PublishStatus`, or `IsDeleted` # # * ServiceNow: `number`, `short_description`, `sys_mod_count`, # `workflow_state`, or `active` # # * Zendesk: `id`, `title`, `updated_at`, or `draft` # # The variable is replaced with the actual value for a piece of # content when calling [GetContent][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RenderingConfiguration AWS API Documentation # class RenderingConfiguration < Struct.new( :template_uri) SENSITIVE = [] include Aws::Structure end # The request reached the service more than 15 minutes after the date # stamp on the request or more than 15 minutes after the request # expiration date (such as for pre-signed URLs), or the date stamp on # the request is more than 15 minutes in the future. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RequestTimeoutException AWS API Documentation # class RequestTimeoutException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The specified resource does not exist. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_name # The specified resource name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message, :resource_name) SENSITIVE = [] include Aws::Structure end # Information about the result. # # @!attribute [rw] document # The document. # @return [Types::Document] # # @!attribute [rw] relevance_score # The relevance score of the results. # @return [Float] # # @!attribute [rw] result_id # The identifier of the result data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ResultData AWS API Documentation # class ResultData < Struct.new( :document, :relevance_score, :result_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] search_expression # The search expression to filter results. # @return [Types::SearchExpression] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContentRequest AWS API Documentation # class SearchContentRequest < Struct.new( :knowledge_base_id, :max_results, :next_token, :search_expression) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content_summaries # Summary information about the content. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContentResponse AWS API Documentation # class SearchContentResponse < Struct.new( :content_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # The search expression. # # @!attribute [rw] filters # The search expression filters. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchExpression AWS API Documentation # class SearchExpression < Struct.new( :filters) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] attributes # The [user-defined Amazon Connect contact attributes][1] to be # resolved when search results are returned. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes # @return [Hash] # # @!attribute [rw] knowledge_base_id # 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. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] search_expression # The search expression for querying the quick response. # @return [Types::QuickResponseSearchExpression] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchQuickResponsesRequest AWS API Documentation # class SearchQuickResponsesRequest < Struct.new( :attributes, :knowledge_base_id, :max_results, :next_token, :search_expression) SENSITIVE = [:attributes] include Aws::Structure end # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] results # The results of the quick response search. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchQuickResponsesResponse AWS API Documentation # class SearchQuickResponsesResponse < Struct.new( :next_token, :results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. Can be either the ID or the # ARN. URLs cannot contain the ARN. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return per page. # @return [Integer] # # @!attribute [rw] next_token # The token for the next set of results. Use the value returned in the # previous response in the next request to retrieve the next set of # results. # @return [String] # # @!attribute [rw] search_expression # The search expression to filter results. # @return [Types::SearchExpression] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessionsRequest AWS API Documentation # class SearchSessionsRequest < Struct.new( :assistant_id, :max_results, :next_token, :search_expression) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # If there are additional results, this is the token for the next set # of results. # @return [String] # # @!attribute [rw] session_summaries # Summary information about the sessions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessionsResponse AWS API Documentation # class SearchSessionsResponse < Struct.new( :next_token, :session_summaries) SENSITIVE = [] include Aws::Structure end # The configuration information for the customer managed key used for # encryption. # # @!attribute [rw] kms_key_id # The customer managed key used for encryption. For more information # about setting up a customer managed key for Wisdom, see [Enable # Amazon Connect Wisdom for your instance][1]. For information about # valid ID values, see [Key identifiers (KeyId)][2]. # # # # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ServerSideEncryptionConfiguration AWS API Documentation # class ServerSideEncryptionConfiguration < Struct.new( :kms_key_id) SENSITIVE = [] include Aws::Structure end # You've exceeded your service quota. To perform the requested action, # remove some of the relevant resources, or use service quotas to # request a service quota increase. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Information about the session. # # @!attribute [rw] description # The description of the session. # @return [String] # # @!attribute [rw] integration_configuration # The configuration information for the session integration. # @return [Types::SessionIntegrationConfiguration] # # @!attribute [rw] name # The name of the session. # @return [String] # # @!attribute [rw] session_arn # The Amazon Resource Name (ARN) of the session. # @return [String] # # @!attribute [rw] session_id # The identifier of the session. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SessionData AWS API Documentation # class SessionData < Struct.new( :description, :integration_configuration, :name, :session_arn, :session_id, :tags) SENSITIVE = [] include Aws::Structure end # The configuration information for the session integration. # # @!attribute [rw] topic_integration_arn # The Amazon Resource Name (ARN) of the integrated Amazon SNS topic # used for streaming chat messages. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SessionIntegrationConfiguration AWS API Documentation # class SessionIntegrationConfiguration < Struct.new( :topic_integration_arn) SENSITIVE = [] include Aws::Structure end # Summary information about the session. # # @!attribute [rw] assistant_arn # The Amazon Resource Name (ARN) of the Wisdom assistant. # @return [String] # # @!attribute [rw] assistant_id # The identifier of the Wisdom assistant. # @return [String] # # @!attribute [rw] session_arn # The Amazon Resource Name (ARN) of the session. # @return [String] # # @!attribute [rw] session_id # The identifier of the session. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SessionSummary AWS API Documentation # class SessionSummary < Struct.new( :assistant_arn, :assistant_id, :session_arn, :session_id) SENSITIVE = [] include Aws::Structure end # Configuration information about the external data source. # # @note SourceConfiguration is a union - when making an API calls you must set exactly one of the members. # # @note SourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SourceConfiguration corresponding to the set member. # # @!attribute [rw] app_integrations # Configuration information for Amazon AppIntegrations to # automatically ingest content. # @return [Types::AppIntegrationsConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SourceConfiguration AWS API Documentation # class SourceConfiguration < Struct.new( :app_integrations, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class AppIntegrations < SourceConfiguration; end class Unknown < SourceConfiguration; end end # @!attribute [rw] content_type # The type of content to upload. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] presigned_url_time_to_live # The expected expiration time of the generated presigned URL, # specified in minutes. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUploadRequest AWS API Documentation # class StartContentUploadRequest < Struct.new( :content_type, :knowledge_base_id, :presigned_url_time_to_live) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] headers_to_include # The headers to include in the upload. # @return [Hash] # # @!attribute [rw] upload_id # The identifier of the upload. # @return [String] # # @!attribute [rw] url # The URL of the upload. # @return [String] # # @!attribute [rw] url_expiry # The expiration time of the URL as an epoch timestamp. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUploadResponse AWS API Documentation # class StartContentUploadResponse < Struct.new( :headers_to_include, :upload_id, :url, :url_expiry) SENSITIVE = [:url] include Aws::Structure end # @!attribute [rw] client_token # The tags used to organize, track, or control access for this # resource. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] external_source_configuration # The configuration information of the external source that the # resource data are imported from. # @return [Types::ExternalSourceConfiguration] # # @!attribute [rw] import_job_type # The type of the import job. # # * For importing quick response resource, set the value to # `QUICK_RESPONSES`. # # ^ # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # # * For importing Wisdom quick responses, this should be a # `QUICK_RESPONSES` type knowledge base. # # ^ # @return [String] # # @!attribute [rw] metadata # The metadata fields of the imported Wisdom resources. # @return [Hash] # # @!attribute [rw] upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartImportJobRequest AWS API Documentation # class StartImportJobRequest < Struct.new( :client_token, :external_source_configuration, :import_job_type, :knowledge_base_id, :metadata, :upload_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_job # The import job. # @return [Types::ImportJobData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartImportJobResponse AWS API Documentation # class StartImportJobResponse < Struct.new( :import_job) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] tags # The tags used to organize, track, or control access for this # resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # Amazon Connect Wisdom throws this exception if you have too many tags # in your tag set. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_name # The specified resource name. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TooManyTagsException AWS API Documentation # class TooManyTagsException < Struct.new( :message, :resource_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] tag_keys # The tag keys. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @!attribute [rw] content_id # The identifier of the content. Can be either the ID or the ARN. URLs # cannot contain the ARN. # @return [String] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN # @return [String] # # @!attribute [rw] metadata # A key/value map to store attributes without affecting tagging or # recommendations. For example, when synchronizing data between an # external system and Wisdom, you can store an external version # identifier as metadata to utilize for determining drift. # @return [Hash] # # @!attribute [rw] override_link_out_uri # The URI for the article. If the knowledge base has a templateUri, # setting this argument overrides it for this piece of content. To # remove an existing `overrideLinkOurUri`, exclude this argument and # set `removeOverrideLinkOutUri` to true. # @return [String] # # @!attribute [rw] remove_override_link_out_uri # Unset the existing `overrideLinkOutUri` if it exists. # @return [Boolean] # # @!attribute [rw] revision_id # The `revisionId` of the content resource to update, taken from an # earlier call to `GetContent`, `GetContentSummary`, `SearchContent`, # or `ListContents`. If included, this argument acts as an optimistic # lock to ensure content was not modified since it was last read. If # it has been modified, this API throws a # `PreconditionFailedException`. # @return [String] # # @!attribute [rw] title # The title of the content. # @return [String] # # @!attribute [rw] upload_id # A pointer to the uploaded asset. This value is returned by # [StartContentUpload][1]. # # # # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContentRequest AWS API Documentation # class UpdateContentRequest < Struct.new( :content_id, :knowledge_base_id, :metadata, :override_link_out_uri, :remove_override_link_out_uri, :revision_id, :title, :upload_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] content # The content. # @return [Types::ContentData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContentResponse AWS API Documentation # class UpdateContentResponse < Struct.new( :content) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] template_uri # The template URI to update. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUriRequest AWS API Documentation # class UpdateKnowledgeBaseTemplateUriRequest < Struct.new( :knowledge_base_id, :template_uri) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] knowledge_base # The knowledge base to update. # @return [Types::KnowledgeBaseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUriResponse AWS API Documentation # class UpdateKnowledgeBaseTemplateUriResponse < Struct.new( :knowledge_base) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] channels # The Amazon Connect contact channels this quick response applies to. # The supported contact channel types include `Chat`. # @return [Array] # # @!attribute [rw] content # The updated content of the quick response. # @return [Types::QuickResponseDataProvider] # # @!attribute [rw] content_type # The media type of the quick response content. # # * Use `application/x.quickresponse;format=plain` for quick response # written in plain text. # # * Use `application/x.quickresponse;format=markdown` for quick # response written in richtext. # @return [String] # # @!attribute [rw] description # The updated description of the quick response. # @return [String] # # @!attribute [rw] grouping_configuration # The updated grouping configuration of the quick response. # @return [Types::GroupingConfiguration] # # @!attribute [rw] is_active # Whether the quick response is active. # @return [Boolean] # # @!attribute [rw] knowledge_base_id # The identifier of the knowledge base. This should not be a # QUICK\_RESPONSES type knowledge base if you're storing Wisdom # Content resource to it. Can be either the ID or the ARN. URLs cannot # contain the ARN. # @return [String] # # @!attribute [rw] language # The language code value for the language in which the quick response # is written. The supported language codes include `de_DE`, `en_US`, # `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, # `zh_CN`, `zh_TW` # @return [String] # # @!attribute [rw] name # The name of the quick response. # @return [String] # # @!attribute [rw] quick_response_id # The identifier of the quick response. # @return [String] # # @!attribute [rw] remove_description # Whether to remove the description from the quick response. # @return [Boolean] # # @!attribute [rw] remove_grouping_configuration # Whether to remove the grouping configuration of the quick response. # @return [Boolean] # # @!attribute [rw] remove_shortcut_key # Whether to remove the shortcut key of the quick response. # @return [Boolean] # # @!attribute [rw] shortcut_key # The shortcut key of the quick response. The value should be unique # across the knowledge base. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateQuickResponseRequest AWS API Documentation # class UpdateQuickResponseRequest < Struct.new( :channels, :content, :content_type, :description, :grouping_configuration, :is_active, :knowledge_base_id, :language, :name, :quick_response_id, :remove_description, :remove_grouping_configuration, :remove_shortcut_key, :shortcut_key) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] quick_response # The quick response. # @return [Types::QuickResponseData] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateQuickResponseResponse AWS API Documentation # class UpdateQuickResponseResponse < Struct.new( :quick_response) SENSITIVE = [] include Aws::Structure end # The input fails to satisfy the constraints specified by a service. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end end end