Aws/qbusiness
@swamp/aws/qbusinessv2026.10.25.1
01README
AWS QBUSINESS infrastructure models
02Release Notes
- Updated: data_accessor, data_source
03Behaviors
@swamp/aws/qbusiness/applicationv2026.10.23.1application.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. |
| AttachmentsConfiguration? | object | |
| AutoSubscriptionConfiguration? | object | |
| ClientIdsForOIDC? | array | |
| Description? | string | |
| DisplayName | string | |
| EncryptionConfiguration? | object | |
| IamIdentityProviderArn? | string | |
| IdentityCenterInstanceArn? | string | |
| IdentityType? | enum | |
| PersonalizationConfiguration? | object | |
| QAppsConfiguration? | object | |
| QuickSightConfiguration? | object | |
| RoleArn? | string | |
| Tags? | array |
fn create()
Create a QBusiness Application
fn get(identifier: string)
Get a QBusiness Application
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Application |
fn update()
Update a QBusiness Application
fn delete(identifier: string)
Delete a QBusiness Application
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Application |
fn sync()
Sync QBusiness Application state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness Application 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)— QBusiness Application resource state
@swamp/aws/qbusiness/data-accessorv2026.10.25.1data_accessor.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. |
| ActionConfigurations | array | |
| ApplicationId | string | |
| AuthenticationDetail? | object | |
| DisplayName | string | |
| Principal | string | |
| Tags? | array |
fn create()
Create a QBusiness DataAccessor
fn get(identifier: string)
Get a QBusiness DataAccessor
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness DataAccessor |
fn update()
Update a QBusiness DataAccessor
fn delete(identifier: string)
Delete a QBusiness DataAccessor
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness DataAccessor |
fn sync()
Sync QBusiness DataAccessor state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness DataAccessor 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)— QBusiness DataAccessor resource state
@swamp/aws/qbusiness/data-sourcev2026.10.25.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. |
| ApplicationId | string | |
| Configuration | unknown | |
| Description? | string | |
| DisplayName | string | |
| DocumentEnrichmentConfiguration? | object | |
| MediaExtractionConfiguration? | object | |
| IndexId | string | |
| RoleArn? | string | |
| SyncSchedule? | string | |
| Tags? | array | |
| VpcConfiguration? | object |
fn create()
Create a QBusiness DataSource
fn get(identifier: string)
Get a QBusiness DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness DataSource |
fn update()
Update a QBusiness DataSource
fn delete(identifier: string)
Delete a QBusiness DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness DataSource |
fn sync()
Sync QBusiness DataSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness 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)— QBusiness DataSource resource state
@swamp/aws/qbusiness/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. |
| ApplicationId | string | |
| CapacityConfiguration? | object | |
| Description? | string | |
| DisplayName | string | |
| DocumentAttributeConfigurations? | array | |
| IndexStatistics? | object | |
| Type? | enum | |
| Tags? | array |
fn create()
Create a QBusiness Index
fn get(identifier: string)
Get a QBusiness Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Index |
fn update()
Update a QBusiness Index
fn delete(identifier: string)
Delete a QBusiness Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Index |
fn sync()
Sync QBusiness Index state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness 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)— QBusiness Index resource state
@swamp/aws/qbusiness/permissionv2026.10.23.1permission.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. |
| ApplicationId | string | |
| StatementId | string | |
| Actions | array | |
| Conditions? | array | |
| Principal | string |
fn create()
Create a QBusiness Permission
fn get(identifier: string)
Get a QBusiness Permission
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Permission |
fn delete(identifier: string)
Delete a QBusiness Permission
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Permission |
fn sync()
Sync QBusiness Permission state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness Permission 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)— QBusiness Permission resource state
@swamp/aws/qbusiness/pluginv2026.10.23.1plugin.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. |
| ApplicationId? | string | |
| AuthConfiguration | object | |
| CustomPluginConfiguration? | object | |
| DisplayName | string | |
| ServerUrl? | string | |
| State? | enum | |
| Tags? | array | |
| Type | enum |
fn create()
Create a QBusiness Plugin
fn get(identifier: string)
Get a QBusiness Plugin
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Plugin |
fn update()
Update a QBusiness Plugin
fn delete(identifier: string)
Delete a QBusiness Plugin
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Plugin |
fn sync()
Sync QBusiness Plugin state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness Plugin 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)— QBusiness Plugin resource state
@swamp/aws/qbusiness/retrieverv2026.10.23.1retriever.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. |
| ApplicationId | string | |
| Configuration | object | |
| DisplayName | string | |
| RoleArn? | string | |
| Tags? | array | |
| Type | enum |
fn create()
Create a QBusiness Retriever
fn get(identifier: string)
Get a QBusiness Retriever
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Retriever |
fn update()
Update a QBusiness Retriever
fn delete(identifier: string)
Delete a QBusiness Retriever
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness Retriever |
fn sync()
Sync QBusiness Retriever state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness Retriever 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)— QBusiness Retriever resource state
@swamp/aws/qbusiness/web-experiencev2026.10.23.1web_experience.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. |
| ApplicationId | string | |
| IdentityProviderConfiguration? | object | |
| RoleArn? | string | |
| SamplePromptsControlMode? | enum | |
| Subtitle? | string | |
| Tags? | array | |
| Title? | string | |
| WelcomeMessage? | string | |
| Origins? | array | |
| CustomizationConfiguration? | object | |
| BrowserExtensionConfiguration? | object |
fn create()
Create a QBusiness WebExperience
fn get(identifier: string)
Get a QBusiness WebExperience
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness WebExperience |
fn update()
Update a QBusiness WebExperience
fn delete(identifier: string)
Delete a QBusiness WebExperience
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QBusiness WebExperience |
fn sync()
Sync QBusiness WebExperience state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QBusiness WebExperience 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)— QBusiness WebExperience resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: application, data_accessor, data_source, index, permission, plugin, retriever, web_experience
2026.10.13.1
- Updated: application, data_accessor, data_source, index, permission, plugin, retriever, web_experience
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
05Stats
A
100 / 100
Downloads
35
Archive size
1.6 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
06Platforms
07Labels