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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateKnowledgeBaseRequest

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:knowledge_base_configuration]

Instance Attribute Summary

• #access_control_configuration ⇒ Types::AccessControlConfiguration

  The access control configuration for the knowledge base.

• #aws_account_id ⇒ String

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

• #data_source_arn ⇒ String

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

• #description ⇒ String

  A description for the knowledge base.

• #knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

  The configuration settings for a knowledge base.

• #knowledge_base_id ⇒ String

  The unique identifier for the knowledge base.

• #media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

  The configuration for media extraction from knowledge base documents.

• #name ⇒ String

  The name of the knowledge base.

• #permissions ⇒ Array<Types::ResourcePermission>

  A list of resource permissions on the knowledge base.

• #primary_owner_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as the primary owner of the knowledge base.

• #tags ⇒ Array<Types::Tag>

  The tags to assign to the knowledge base.

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:

• (Types::AccessControlConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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:

• (Types::KnowledgeBaseConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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:

• (Types::MediaExtractionConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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:

• (Array<Types::ResourcePermission>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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 Amazon QuickSight user or group to set as the primary owner of the knowledge base. The specified principal is always granted owner access, regardless of what is specified in the Permissions field.

This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN. The API caller is never assigned as the owner automatically. If you don't specify a primary owner and don't grant owner access in Permissions, the knowledge base is created without an owner, even when you call the operation as an Amazon QuickSight user.

When you call CreateKnowledgeBase as an IAM user or an assumed IAM role, specify PrimaryOwnerArn (as an Amazon QuickSight principal ARN) or an owner entry in Permissions so that the knowledge base has an owner. Although optional, specifying a primary owner is recommended.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 12262

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