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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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

#capacity_configurationTypes::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.



7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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

#descriptionString

The description of the Amazon Q Business index.

Returns:

  • (String)


7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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

#display_nameString

The name of the Amazon Q Business index.

Returns:

  • (String)


7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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

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



7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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

#index_idString

The identifier of the Amazon Q Business index.

Returns:

  • (String)


7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7740

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