Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . kendra ]

update-index

Description

Updates an existing Amazon Kendra index.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-index
--id <value>
[--name <value>]
[--role-arn <value>]
[--description <value>]
[--document-metadata-configuration-updates <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The identifier of the index to update.

--name (string)

The name of the index to update.

--role-arn (string)

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

--description (string)

A new description for the index.

--document-metadata-configuration-updates (list)

The document metadata to update.

Shorthand Syntax:

Name=string,Type=string,Relevance={Freshness=boolean,Importance=integer,Duration=string,RankOrder=string,ValueImportanceMap={KeyName1=integer,KeyName2=integer}},Search={Facetable=boolean,Searchable=boolean,Displayable=boolean} ...

JSON Syntax:

[
  {
    "Name": "string",
    "Type": "STRING_VALUE"|"STRING_LIST_VALUE"|"LONG_VALUE"|"DATE_VALUE",
    "Relevance": {
      "Freshness": true|false,
      "Importance": integer,
      "Duration": "string",
      "RankOrder": "ASCENDING"|"DESCENDING",
      "ValueImportanceMap": {"string": integer
        ...}
    },
    "Search": {
      "Facetable": true|false,
      "Searchable": true|false,
      "Displayable": true|false
    }
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None