Class: Aws::QBusiness::Types::DocumentAttributeConfiguration

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

Overview

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see [Understanding document attributes].

[1]: docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the document attribute.

Returns:

  • (String) 


3109
3110
3111
3112
3113
3114
3115
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3109

class DocumentAttributeConfiguration < Struct.new(
  :name,
  :type,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#search ⇒ String

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Returns:

  • (String) 


3109
3110
3111
3112
3113
3114
3115
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3109

class DocumentAttributeConfiguration < Struct.new(
  :name,
  :type,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of document attribute.

Returns:

  • (String) 


3109
3110
3111
3112
3113
3114
3115
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3109

class DocumentAttributeConfiguration < Struct.new(
  :name,
  :type,
  :search)
  SENSITIVE = []
  include Aws::Structure
end