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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::UpdateIndexRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #capacity_configuration ⇒ Types::IndexCapacityConfiguration

  The storage capacity units you want to provision for your Amazon Q Business index.

• #description ⇒ String

  The description of the Amazon Q Business index.

• #display_name ⇒ String

  The name of the Amazon Q Business index.

• #document_attribute_configurations ⇒ Array<Types::DocumentAttributeConfiguration>

  Configuration information for document metadata or fields.

• #index_id ⇒ String

  The identifier of the Amazon Q Business index.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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:

• (Types::IndexCapacityConfiguration)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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.

Returns:

• (Array<Types::DocumentAttributeConfiguration>)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5843

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