Class: Aws::Kendra::Types::UpdateIndexRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateIndexRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_units ⇒ Types::CapacityUnitsConfiguration

  Sets the number of additional document storage and query capacity units that should be used by the index.

• #description ⇒ String

  A new description for the index.

• #document_metadata_configuration_updates ⇒ Array<Types::DocumentMetadataConfiguration>

  The document metadata configuration you want to update for the index.

• #id ⇒ String

  The identifier of the index you want to update.

• #name ⇒ String

  The name of the index you want to update.

• #role_arn ⇒ String

  An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

• #user_context_policy ⇒ String

  The user context policy.

• #user_group_resolution_configuration ⇒ Types::UserGroupResolutionConfiguration

  Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source.

• #user_token_configurations ⇒ Array<Types::UserTokenConfiguration>

  The user token configuration.

Instance Attribute Details

#capacity_units ⇒ Types::CapacityUnitsConfiguration

Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

Returns:

• (Types::CapacityUnitsConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A new description for the index.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_metadata_configuration_updates ⇒ Array<Types::DocumentMetadataConfiguration>

The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

Returns:

• (Array<Types::DocumentMetadataConfiguration>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the index you want to update.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the index you want to update.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_context_policy ⇒ String

The user context policy.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_resolution_configuration ⇒ Types::UserGroupResolutionConfiguration

Enables fetching access levels of groups and users from an IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration.

Returns:

• (Types::UserGroupResolutionConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_token_configurations ⇒ Array<Types::UserTokenConfiguration>

The user token configuration.

Returns:

• (Array<Types::UserTokenConfiguration>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10146

class UpdateIndexRequest < Struct.new(
  :id,
  :name,
  :role_arn,
  :description,
  :document_metadata_configuration_updates,
  :capacity_units,
  :user_token_configurations,
  :user_context_policy,
  :user_group_resolution_configuration)
  SENSITIVE = []
  include Aws::Structure
end