Class: Aws::QuickSight::Types::CreateKnowledgeBaseRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:knowledge_base_configuration]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_configuration ⇒ Types::AccessControlConfiguration

The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.

Returns:



9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#aws_account_id ⇒ String

The ID of the Amazon Web Services account that contains the knowledge base.

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#data_source_arn ⇒ String

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

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#description ⇒ String

A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

The configuration settings for a knowledge base.

Returns:



9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The unique identifier for the knowledge base.

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

The configuration for media extraction from knowledge base documents.

Returns:



9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#name ⇒ String

The name of the knowledge base.

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#permissions ⇒ Array<Types::ResourcePermission>

A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.

Returns:



9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#primary_owner_arn ⇒ String

The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the Permissions field. If you don't specify a primary owner, the knowledge base is created without one.

Returns:

  • (String) 


9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.

Returns:



9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 9515

class CreateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :data_source_arn,
  :knowledge_base_configuration,
  :description,
  :permissions,
  :media_extraction_configuration,
  :access_control_configuration,
  :primary_owner_arn,
  :tags)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end