Class: Aws::QConnect::Types::CreateKnowledgeBaseRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#description ⇒ String

The description.

Returns:

  • (String) 


993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#knowledge_base_type ⇒ String

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.

Returns:

  • (String) 


993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#name ⇒ String

The name of the knowledge base.

Returns:

  • (String) 


993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#rendering_configuration ⇒ Types::RenderingConfiguration

Information about how to render the content.

Returns:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#source_configuration ⇒ Types::SourceConfiguration

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

Returns:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>) 


993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 993

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