Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kendra ]

describe-index

Description

Describes an existing Amazon Kendra index

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-index
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The name of the index to describe.

--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

Name -> (string)

The name of the index.

Id -> (string)

the name of the index.

Edition -> (string)

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

ServerSideEncryptionConfiguration -> (structure)

The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

KmsKeyId -> (string)

The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

Status -> (string)

The current status of the index. When the value is ACTIVE , the index is ready for use. If the Status field value is FAILED , the ErrorMessage field contains a message that explains why.

Description -> (string)

The description of the index.

CreatedAt -> (timestamp)

The Unix datetime that the index was created.

UpdatedAt -> (timestamp)

The Unix datetime that the index was last updated.

DocumentMetadataConfigurations -> (list)

Configuration settings for any metadata applied to the documents in the index.

(structure)

Specifies the properties of a custom index field.

Name -> (string)

The name of the index field.

Type -> (string)

The data type of the index field.

Relevance -> (structure)

Provides manual tuning parameters to determine how the field affects the search results.

Freshness -> (boolean)

Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

Importance -> (integer)

The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

Duration -> (string)

Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use "2628000s". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character "s", for example "86400s" for one day, or "604800s" for one week.

Only applies to DATE fields.

RankOrder -> (string)

Determines how values should be interpreted.

When the RankOrder field is ASCENDING , higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

When the RankOrder field is DESCENDING , lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

Only applies to LONG and DOUBLE fields.

ValueImportanceMap -> (map)

A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called "department," query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

key -> (string)

value -> (integer)

Search -> (structure)

Provides information about how the field is used during a search.

Facetable -> (boolean)

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

Searchable -> (boolean)

Determines whether the field is used in the search. If the Searchable field is true , you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

Displayable -> (boolean)

Determines whether the field is returned in the query response. The default is true .

Sortable -> (boolean)

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true , Amazon Kendra returns an exception. The default is false .

IndexStatistics -> (structure)

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

FaqStatistics -> (structure)

The number of question and answer topics in the index.

IndexedQuestionAnswersCount -> (integer)

The total number of FAQ questions and answers contained in the index.

TextDocumentStatistics -> (structure)

The number of text documents indexed.

IndexedTextDocumentsCount -> (integer)

The number of text documents indexed.

IndexedTextBytes -> (long)

The total size, in bytes, of the indexed documents.

ErrorMessage -> (string)

When th e``Status`` field value is FAILED , the ErrorMessage field contains a message that explains why.

CapacityUnits -> (structure)

For enterprise edtion indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.

StorageCapacityUnits -> (integer)

The amount of extra storage capacity for an index. Each capacity unit provides 150 Gb of storage space or 500,000 documents, whichever is reached first.

QueryCapacityUnits -> (integer)

The amount of extra query capacity for an index. Each capacity unit provides 0.5 queries per second and 40,000 queries per day.

UserTokenConfigurations -> (list)

The user token configuration for the Amazon Kendra index.

(structure)

Provides configuration information for a token configuration.

JwtTokenTypeConfiguration -> (structure)

Information about the JWT token type configuration.

KeyLocation -> (string)

The location of the key.

URL -> (string)

The signing key URL.

SecretManagerArn -> (string)

The Amazon Resource Name (arn) of the secret.

UserNameAttributeField -> (string)

The user name attribute field.

GroupAttributeField -> (string)

The group attribute field.

Issuer -> (string)

The issuer of the token.

ClaimRegex -> (string)

The regular expression that identifies the claim.

JsonTokenTypeConfiguration -> (structure)

Information about the JSON token type configuration.

UserNameAttributeField -> (string)

The user name attribute field.

GroupAttributeField -> (string)

The group attribute field.

UserContextPolicy -> (string)

The user context policy for the Amazon Kendra index.