ListIndexTool
List indices in an OpenSearch cluster. Specify an index name or pattern to filter results, and choose whether to include full metadata or only index names.
Instructions
Lists indices in the OpenSearch cluster. If an index name or pattern is specified, return only information about the provided index or index pattern. The include_detail flag controls output: if False, returns only index name(s); if True (default), returns full metadata.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | No | The name of the index or index pattern to get information for. | |
| aws_region | No | AWS region for IAM/Serverless authentication. | |
| aws_iam_arn | No | IAM role ARN for role-based authentication. | |
| aws_profile | No | AWS profile name for authentication. | |
| include_detail | No | Whether to include detailed information. If False, returns only index name(s). If True, returns full metadata. | |
| opensearch_url | Yes | OpenSearch endpoint URL. | |
| opensearch_no_auth | No | If true, connect without authentication. | |
| opensearch_timeout | No | Connection timeout in seconds. | |
| opensearch_password | No | Password for basic authentication. | |
| opensearch_username | No | Username for basic authentication. | |
| opensearch_ssl_verify | No | If false, disable SSL certificate verification. | |
| aws_opensearch_serverless | No | If true, use OpenSearch Serverless service. |