Class: Aws::ConnectWisdomService::Types::KnowledgeBaseSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connectwisdomservice/types.rb

Overview

Summary information about the knowledge base.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the knowledge base.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#knowledge_base_arn ⇒ String

The Amazon Resource Name (ARN) of the knowledge base.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#knowledge_base_id ⇒ String

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.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#knowledge_base_type ⇒ String

The type of knowledge base.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#name ⇒ String

The name of the knowledge base.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#rendering_configuration ⇒ Types::RenderingConfiguration

Information about how to render the content.

Returns:



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#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/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]: docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html

Returns:



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#source_configuration ⇒ Types::SourceConfiguration

Configuration information about the external data source.

Returns:



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#status ⇒ String

The status of the knowledge base summary.

Returns:

  • (String) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-connectwisdomservice/types.rb', line 1986

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