LinuxCommandLibrary

aws-kendra

Manage and search Kendra intelligent search indexes

TLDR

Create an index

$ aws kendra create-index --name [name] --role-arn [role_arn]
copy

List indexes
$ aws kendra list-indexes
copy

Describe an index
$ aws kendra describe-index --id [index_id]
copy

List data sources
$ aws kendra list-data-sources
copy

Describe a data source
$ aws kendra describe-data-source --id [data_source_id]
copy

List search queries
$ aws kendra list-query-suggestions --index-id [index_id] --query-text [query_text]
copy

SYNOPSIS

aws kendra subcommand [--endpoint-url URL] [--region REGION] [--help] [--cli-input-json FILE]

PARAMETERS

--help
    Show help for the command

--endpoint-url
    Override default endpoint URL

--region
    AWS region (e.g., us-east-1)

--profile
    Use specific profile from credentials file

--debug
    Turn on debug logging

--cli-input-json
    Perform operation using JSON input

--no-paginate
    Disable automatic pagination

--output
    Output format: json|text|table

--query
    JMESPath query to filter output

--no-cli-pager
    Disable cli pager for output

DESCRIPTION

The aws kendra command is part of the AWS Command Line Interface (CLI) for managing Amazon Kendra, a fully managed enterprise search service powered by machine learning. It enables users to index documents from various sources like S3, databases, and SharePoint, then query them using natural language search.

With aws kendra, you can create and configure indexes, connect data sources, upload FAQs, suggest queries, and retrieve search results programmatically. It's ideal for developers automating search infrastructure in CI/CD pipelines, scripts, or integrating with other AWS services.

Requires AWS CLI version 2 (recommended) installed and configured with credentials via aws configure. Supports all AWS regions where Kendra is available. Operations are billed based on indexed content, queries, and storage.

Key use cases include building internal knowledge bases, customer support search, or e-commerce product discovery without managing ML infrastructure.

CAVEATS

Requires AWS CLI v2 installed and IAM permissions for Kendra actions. Not all subcommands support all options; check aws kendra <subcommand> help. Rate limits apply per API.

COMMON SUBCOMMANDS

create-index, describe-index, list-data-sources, query, suggest, delete-index — use aws kendra help for full list.

AUTHENTICATION

Configure via aws configure or environment variables like AWS_ACCESS_KEY_ID. Supports SSO and MFA.

EXAMPLES

aws kendra create-index --name MyIndex --role-arn arn:aws:iam::123:role/KendraRole
aws kendra query --index-id abc123 --query-text 'What is AWS?' --region us-east-1

HISTORY

Introduced with AWS CLI v2 in 2020 alongside Amazon Kendra GA. Kendra evolved from 2019 preview, with CLI supporting new features like hybrid search (2023) and generative AI connectors.

SEE ALSO

aws(1), aws s3(1), aws iam(1)

Copied to clipboard