Class: Aws::QuickSight::Types::UpdateKnowledgeBaseRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::UpdateKnowledgeBaseRequest

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.

• #description ⇒ String

  A description for the knowledge base.

• #is_email_notification_opted_for_ingestion_failures ⇒ Boolean

  Specifies whether email notifications are enabled for ingestion failures.

• #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.

Instance Attribute Details

#access_control_configuration ⇒ Types::AccessControlConfiguration

The access control configuration for the knowledge base. If you don't specify this parameter, the existing setting is retained.

Returns:

• (Types::AccessControlConfiguration)

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

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  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 52295

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#description ⇒ String

A description for the knowledge base. If you don't specify a description, the existing description is retained.

Returns:

• (String)

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

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#is_email_notification_opted_for_ingestion_failures ⇒ Boolean

Specifies whether email notifications are enabled for ingestion failures.

Returns:

• (Boolean)

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

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  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 52295

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  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 52295

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  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 52295

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end

#name ⇒ String

The name of the knowledge base. If you don't specify a name, the existing name is retained.

Returns:

• (String)

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

class UpdateKnowledgeBaseRequest < Struct.new(
  :aws_account_id,
  :knowledge_base_id,
  :name,
  :description,
  :knowledge_base_configuration,
  :media_extraction_configuration,
  :is_email_notification_opted_for_ingestion_failures,
  :access_control_configuration)
  SENSITIVE = [:knowledge_base_configuration]
  include Aws::Structure
end