Class: Aws::QuickSight::Types::KnowledgeBaseSummary

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::KnowledgeBaseSummary

Defined in:

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

Overview

A summary of a knowledge base, including its identifier, name, status, and metadata.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:primary_owner_username]

Instance Attribute Summary

• #created_at ⇒ Time

  The date and time that the knowledge base was created.

• #data_source_arn ⇒ String

  The ARN of the data source associated with the knowledge base.

• #document_count ⇒ Integer

  The number of documents in the knowledge base.

• #knowledge_base_arn ⇒ String

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

• #knowledge_base_id ⇒ String

  The unique identifier for the knowledge base.

• #knowledge_base_size_bytes ⇒ Integer

  The size of the knowledge base in bytes.

• #name ⇒ String

  The name of the knowledge base.

• #primary_owner_arn ⇒ String

  The ARN of the primary owner of the knowledge base.

• #primary_owner_username ⇒ String

  The username of the primary owner of the knowledge base.

• #status ⇒ String

  The status of the knowledge base.

• #type ⇒ String

  The type of the knowledge base.

• #updated_at ⇒ Time

  The date and time that the knowledge base was last updated.

Instance Attribute Details

#created_at ⇒ Time

The date and time that the knowledge base was created.

Returns:

• (Time)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#data_source_arn ⇒ String

The ARN of the data source associated with the knowledge base.

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#document_count ⇒ Integer

The number of documents in the knowledge base.

Returns:

• (Integer)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#knowledge_base_arn ⇒ String

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

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  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 26938

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#knowledge_base_size_bytes ⇒ Integer

The size of the knowledge base in bytes.

Returns:

• (Integer)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  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 26938

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#primary_owner_arn ⇒ String

The ARN of the primary owner of the knowledge base.

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#primary_owner_username ⇒ String

The username of the primary owner of the knowledge base.

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#status ⇒ String

The status of the knowledge base.

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#type ⇒ String

The type of the knowledge base.

Returns:

• (String)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time that the knowledge base was last updated.

Returns:

• (Time)

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

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_arn,
  :knowledge_base_id,
  :name,
  :status,
  :data_source_arn,
  :type,
  :created_at,
  :updated_at,
  :knowledge_base_size_bytes,
  :document_count,
  :primary_owner_arn,
  :primary_owner_username)
  SENSITIVE = [:primary_owner_username]
  include Aws::Structure
end