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

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

Overview

Note:

When making an API call, you may pass UpdateIndexRequest data as a hash:

{
  id: "IndexId", # required
  name: "IndexName",
  role_arn: "RoleArn",
  description: "Description",
  document_metadata_configuration_updates: [
    {
      name: "DocumentMetadataConfigurationName", # required
      type: "STRING_VALUE", # required, accepts STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE
      relevance: {
        freshness: false,
        importance: 1,
        duration: "Duration",
        rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
        value_importance_map: {
          "ValueImportanceMapKey" => 1,
        },
      },
      search: {
        facetable: false,
        searchable: false,
        displayable: false,
        sortable: false,
      },
    },
  ],
  capacity_units: {
    storage_capacity_units: 1, # required
    query_capacity_units: 1, # required
  },
  user_token_configurations: [
    {
      jwt_token_type_configuration: {
        key_location: "URL", # required, accepts URL, SECRET_MANAGER
        url: "Url",
        secret_manager_arn: "RoleArn",
        user_name_attribute_field: "UserNameAttributeField",
        group_attribute_field: "GroupAttributeField",
        issuer: "Issuer",
        claim_regex: "ClaimRegex",
      },
      json_token_type_configuration: {
        user_name_attribute_field: "String", # required
        group_attribute_field: "String", # required
      },
    },
  ],
  user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_unitsTypes::CapacityUnitsConfiguration

Sets the number of addtional 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.

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


6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#descriptionString

A new description for the index.

Returns:

  • (String)

6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#document_metadata_configuration_updatesArray<Types::DocumentMetadataConfiguration>

The document metadata to update.


6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#idString

The identifier of the index to update.

Returns:

  • (String)

6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#nameString

The name of the index to update.

Returns:

  • (String)

6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#role_arnString

A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.

Returns:

  • (String)

6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#user_context_policyString

The user user token context policy.

Returns:

  • (String)

6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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

#user_token_configurationsArray<Types::UserTokenConfiguration>

The user token configuration.

Returns:


6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# File 'lib/aws-sdk-kendra/types.rb', line 6643

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