Class: Aws::QBusiness::Types::UpdateIndexRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The identifier of the Amazon Q Business application connected to the index.

Returns:

  • (String) 


9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_configuration ⇒ Types::IndexCapacityConfiguration

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

Returns:



9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the Amazon Q Business index.

Returns:

  • (String) 


9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the Amazon Q Business index.

Returns:

  • (String) 


9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#document_attribute_configurations ⇒ Array<Types::DocumentAttributeConfiguration>

Configuration information for document metadata or fields. Document metadata are fields or attributes 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-types.html#doc-attributes

Returns:



9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the Amazon Q Business index.

Returns:

  • (String) 


9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 9009

class UpdateIndexRequest < Struct.new(
  :application_id,
  :index_id,
  :display_name,
  :description,
  :capacity_configuration,
  :document_attribute_configurations)
  SENSITIVE = []
  include Aws::Structure
end