Aws/kendra
@swamp/aws/kendrav2026.10.25.1
01README
AWS KENDRA infrastructure models
02Behaviors
@swamp/aws/kendra/data-sourcev2026.10.23.1data_source.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | Name of data source |
| IndexId | string | ID of Index |
| Type | enum | Data source type |
| DataSourceConfiguration? | object | |
| Description? | string | Description of data source |
| Schedule? | string | Schedule |
| RoleArn? | string | Role ARN |
| Tags? | array | Tags for labeling the data source |
| CustomDocumentEnrichmentConfiguration? | object | |
| LanguageCode? | string | The code for a language. |
fn create()
Create a Kendra DataSource
fn get(identifier: string)
Get a Kendra DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra DataSource |
fn update()
Update a Kendra DataSource
fn delete(identifier: string)
Delete a Kendra DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra DataSource |
fn sync()
Sync Kendra DataSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra DataSource resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra DataSource resource state
@swamp/aws/kendra/faqv2026.10.23.1faq.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| IndexId | string | Index ID |
| Name | string | FAQ name |
| Description? | string | FAQ description |
| FileFormat? | enum | FAQ file format |
| S3Path | object | FAQ S3 path |
| RoleArn | string | FAQ role ARN |
| Tags? | array | Tags for labeling the FAQ |
| LanguageCode? | string | The code for a language. |
fn create()
Create a Kendra Faq
fn get(identifier: string)
Get a Kendra Faq
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Faq |
fn update()
Update a Kendra Faq
fn delete(identifier: string)
Delete a Kendra Faq
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Faq |
fn sync()
Sync Kendra Faq state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra Faq resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra Faq resource state
@swamp/aws/kendra/featured-results-setv2026.10.23.1featured_results_set.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| IndexId | string | The identifier of the index that you want to use for featuring results. |
| FeaturedResultsSetName | string | A name for the set of featured results. |
| Description? | string | A description for the set of featured results. |
| Status? | enum | The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. |
| QueryTexts? | array | A list of queries for featuring results. |
| FeaturedDocuments? | array | A list of document IDs for the documents you want to feature at the top of the search results page. |
| Tags? | array | A list of key-value pairs that identify or categorize the featured results set. |
fn create()
Create a Kendra FeaturedResultsSet
fn get(identifier: string)
Get a Kendra FeaturedResultsSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra FeaturedResultsSet |
fn update()
Update a Kendra FeaturedResultsSet
fn delete(identifier: string)
Delete a Kendra FeaturedResultsSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra FeaturedResultsSet |
fn sync()
Sync Kendra FeaturedResultsSet state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra FeaturedResultsSet resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra FeaturedResultsSet resource state
@swamp/aws/kendra/indexv2026.10.23.1index.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | A description for the index |
| ServerSideEncryptionConfiguration? | object | Server side encryption configuration |
| Tags? | array | Tags for labeling the index |
| Name | string | Name of index |
| RoleArn | string | Role Arn |
| Edition | enum | Edition of index |
| DocumentMetadataConfigurations? | array | Document metadata configurations |
| CapacityUnits? | object | Capacity units |
| UserContextPolicy? | enum | |
| UserTokenConfigurations? | array |
fn create()
Create a Kendra Index
fn get(identifier: string)
Get a Kendra Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Index |
fn update()
Update a Kendra Index
fn delete(identifier: string)
Delete a Kendra Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Index |
fn sync()
Sync Kendra Index state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra Index resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra Index resource state
@swamp/aws/kendra/query-suggestions-block-listv2026.10.23.1query_suggestions_block_list.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| IndexId | string | The identifier of the index for the block list. |
| Name | string | The name of the block list. |
| Description? | string | A description for the block list. |
| SourceS3Path | object | Information required to find a specific file in an Amazon S3 bucket. |
| RoleArn | string | The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the block list text file. |
| Tags? | array | A list of key-value pairs that identify or categorize the block list. |
fn create()
Create a Kendra QuerySuggestionsBlockList
fn get(identifier: string)
Get a Kendra QuerySuggestionsBlockList
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra QuerySuggestionsBlockList |
fn update()
Update a Kendra QuerySuggestionsBlockList
fn delete(identifier: string)
Delete a Kendra QuerySuggestionsBlockList
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra QuerySuggestionsBlockList |
fn sync()
Sync Kendra QuerySuggestionsBlockList state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra QuerySuggestionsBlockList resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra QuerySuggestionsBlockList resource state
@swamp/aws/kendra/thesaurusv2026.10.23.1thesaurus.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| IndexId | string | The identifier of the index for the thesaurus. |
| Name | string | A name for the thesaurus. |
| Description? | string | A description for the thesaurus. |
| RoleArn | string | An IAM role that gives Amazon Kendra permissions to access the thesaurus file specified in SourceS3Path. |
| SourceS3Path | object | Information required to find a specific file in an Amazon S3 bucket. |
| Tags? | array | A list of key-value pairs that identify or categorize the thesaurus. |
fn create()
Create a Kendra Thesaurus
fn get(identifier: string)
Get a Kendra Thesaurus
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Thesaurus |
fn update()
Update a Kendra Thesaurus
fn delete(identifier: string)
Delete a Kendra Thesaurus
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Kendra Thesaurus |
fn sync()
Sync Kendra Thesaurus state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Kendra Thesaurus resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— Kendra Thesaurus resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: data_source, faq, featured_results_set, index, query_suggestions_block_list, thesaurus
2026.10.13.1
- Updated: data_source, faq, featured_results_set, index, query_suggestions_block_list, thesaurus
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
04Stats
A
100 / 100
Downloads
197
Archive size
1.2 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels