Aws/quicksight
@swamp/aws/quicksightv2026.10.25.1
01README
AWS QUICKSIGHT infrastructure models
02Release Notes
- Updated: analysis, dashboard, data_set, flow, refresh_schedule, template, theme
03Behaviors
@swamp/aws/quicksight/action-connectorv2026.10.23.1action_connector.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. |
| ActionConnectorId | string | |
| AuthenticationConfig | object | |
| AwsAccountId | string | |
| Description? | string | |
| Name | string | |
| Permissions? | array | |
| Tags? | array | |
| Type | enum | |
| VpcConnectionArn? | string |
fn create()
Create a QuickSight ActionConnector
fn get(identifier: string)
Get a QuickSight ActionConnector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight ActionConnector |
fn update()
Update a QuickSight ActionConnector
fn delete(identifier: string)
Delete a QuickSight ActionConnector
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight ActionConnector |
fn sync()
Sync QuickSight ActionConnector state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight ActionConnector 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)— QuickSight ActionConnector resource state
@swamp/aws/quicksight/agentv2026.10.23.1agent.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. |
| AwsAccountId | string | The ID of the Amazon Web Services account where the agent is being created. |
| AgentId | string | The unique identifier for the agent. |
| Name | string | The display name of the agent. |
| Description? | string | A description of the agent. |
| IconId? | string | The icon identifier for the agent. |
| StarterPrompts? | array | A list of up to 3 starter prompts displayed to users. |
| WelcomeMessage? | string | The welcome message displayed when a user opens the agent. |
| AgentLifecycle? | enum | The lifecycle stage of the agent. PREVIEW or PUBLISHED. |
| CustomPromptInput? | object | Custom prompt configuration. Specify either ExistingPrompt or NewPrompt. |
| Spaces? | array | A list of Space ARNs (max 10) attached to the agent. |
| ActionConnectors? | array | A list of ActionConnector ARNs (max 10) attached to the agent. |
| Tags? | array | A list of key-value pairs to associate with the agent resource. |
| CustomPromptInterface? | object | Read-only view of the resolved custom prompt interface for the agent. |
fn create()
Create a QuickSight Agent
fn get(identifier: string)
Get a QuickSight Agent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Agent |
fn update()
Update a QuickSight Agent
fn delete(identifier: string)
Delete a QuickSight Agent
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Agent |
fn sync()
Sync QuickSight Agent state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Agent 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)— QuickSight Agent resource state
@swamp/aws/quicksight/analysisv2026.10.25.1analysis.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. |
| Status? | enum | |
| Parameters? | object | A list of Quick parameters and the list's override values. |
| SourceEntity? | object | The source entity of an analysis. |
| ThemeArn? | string | The ARN of the theme of the analysis. |
| Definition? | object | |
| ValidationStrategy? | object | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors. |
| FolderArns? | array | |
| Name | string | The descriptive name of the analysis. |
| Errors? | array | Errors associated with the analysis. |
| AnalysisId | string | |
| AwsAccountId | string | |
| Permissions? | array | |
| Tags? | array | |
| Sheets? | array | A list of the associated sheets with the unique identifier and name of each sheet. |
fn create()
Create a QuickSight Analysis
fn get(identifier: string)
Get a QuickSight Analysis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Analysis |
fn update()
Update a QuickSight Analysis
fn delete(identifier: string)
Delete a QuickSight Analysis
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Analysis |
fn sync()
Sync QuickSight Analysis state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Analysis 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)— QuickSight Analysis resource state
@swamp/aws/quicksight/approval-policyv2026.10.23.1approval_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| ApplicableTo | object | Scoping: who the policy applies to. GROUP: `groupArns` required (one or more group ARNs). |
| AssetTypes | array | List of asset types a policy applies to. At least one asset type is required. |
| Description? | string | |
| Actions | array | List of governed actions a policy applies to. |
| ApprovalGroups | array | List of approval group ARNs (e.g. QuickSight group ARNs). At least one approval group is required; the upper bound is enforced per-account at the service layer via the configurable approver-group limit. |
| PolicyId | string | |
| Name | string |
fn create()
Create a QuickSight ApprovalPolicy
fn get(identifier: string)
Get a QuickSight ApprovalPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight ApprovalPolicy |
fn update()
Update a QuickSight ApprovalPolicy
fn delete(identifier: string)
Delete a QuickSight ApprovalPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight ApprovalPolicy |
fn sync()
Sync QuickSight ApprovalPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight ApprovalPolicy 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)— QuickSight ApprovalPolicy resource state
@swamp/aws/quicksight/assignmentv2026.10.23.1assignment.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. |
| AssignmentName | string | The name of the assignment, also called a rule. The name must be unique within the AWS account. |
| AssignmentStatus | enum | The status of the assignment. |
| Namespace | string | The namespace that contains the assignment. |
| Identities? | record | The QuickSight users, groups, or both that you want to assign the policy to. This maps identity type to a list of identity names. |
| PolicyArn? | string | The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment. |
fn create()
Create a QuickSight Assignment
fn get(identifier: string)
Get a QuickSight Assignment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Assignment |
fn update()
Update a QuickSight Assignment
fn delete(identifier: string)
Delete a QuickSight Assignment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Assignment |
fn sync()
Sync QuickSight Assignment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Assignment 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)— QuickSight Assignment resource state
@swamp/aws/quicksight/brandv2026.10.23.1brand.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. |
| BrandId | string | The ID of the QuickSight brand. |
| BrandDefinition? | object | |
| Tags? | array | The tags for the brand. |
fn create()
Create a QuickSight Brand
fn get(identifier: string)
Get a QuickSight Brand
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Brand |
fn update()
Update a QuickSight Brand
fn delete(identifier: string)
Delete a QuickSight Brand
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Brand |
fn sync()
Sync QuickSight Brand state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Brand 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)— QuickSight Brand resource state
@swamp/aws/quicksight/custom-permissionsv2026.10.23.1custom_permissions.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. |
| AwsAccountId | string | |
| Capabilities? | object | |
| CustomPermissionsName | string | |
| Tags? | array |
fn create()
Create a QuickSight CustomPermissions
fn get(identifier: string)
Get a QuickSight CustomPermissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight CustomPermissions |
fn update()
Update a QuickSight CustomPermissions
fn delete(identifier: string)
Delete a QuickSight CustomPermissions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight CustomPermissions |
fn sync()
Sync QuickSight CustomPermissions state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight CustomPermissions 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)— QuickSight CustomPermissions resource state
@swamp/aws/quicksight/customizationv2026.10.23.1customization.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. |
| Namespace | string | The QuickSight namespace the customization applies to. One customization exists per (account, region, namespace), so this is create-only: changing it addresses a different resource. |
| DefaultTheme | string | The ARN of the theme applied by default in the QuickSight console for this namespace. May be an AWS-managed starter theme such as arn:{Partition}:quicksight::aws:theme/MIDNIGHT or a theme owned by this account. |
| Tags? | array | Tags applied to the customization. QuickSight rejects any key prefixed aws: or quicksight:, so CloudFormation system tags are not propagated. |
fn create()
Create a QuickSight Customization
fn get(identifier: string)
Get a QuickSight Customization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Customization |
fn update()
Update a QuickSight Customization
fn delete(identifier: string)
Delete a QuickSight Customization
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Customization |
fn sync()
Sync QuickSight Customization state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Customization 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)— QuickSight Customization resource state
@swamp/aws/quicksight/dashboardv2026.10.25.1dashboard.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. |
| Parameters? | object | A list of Quick parameters and the list's override values. |
| VersionDescription? | string | |
| SourceEntity? | object | Dashboard source entity. |
| ThemeArn? | string | |
| Definition? | object | |
| ValidationStrategy? | object | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors. |
| FolderArns? | array | |
| DashboardId | string | |
| LinkSharingConfiguration? | object | |
| Name | string | |
| DashboardPublishOptions? | object | Dashboard publish options. |
| Version? | object | Dashboard version. |
| AwsAccountId | string | |
| Permissions? | array | |
| LinkEntities? | array | |
| Tags? | array |
fn create()
Create a QuickSight Dashboard
fn get(identifier: string)
Get a QuickSight Dashboard
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Dashboard |
fn update()
Update a QuickSight Dashboard
fn delete(identifier: string)
Delete a QuickSight Dashboard
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Dashboard |
fn sync()
Sync QuickSight Dashboard state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Dashboard 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)— QuickSight Dashboard resource state
@swamp/aws/quicksight/data-setv2026.10.25.1data_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. |
| FolderArns? | array | When you create the dataset, Amazon QuickSight adds the dataset to these folders. |
| RowLevelPermissionDataSet? | object | Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets. |
| IngestionWaitPolicy? | object | Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours. |
| ColumnLevelPermissionRules? | array | A set of one or more definitions of a ColumnLevelPermissionRule . |
| Name? | string | The display name for the dataset. |
| Permissions? | array | A list of resource permissions on the dataset. |
| UseAs? | enum | |
| Tags? | array | Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
| PhysicalTableMap? | record | |
| FieldFolders? | record | |
| SemanticModelConfiguration? | object | |
| DataSetId? | string | |
| PerformanceConfiguration? | object | |
| DataSetRefreshProperties? | object | The refresh properties of a dataset. |
| RowLevelPermissionTagConfiguration? | object | The configuration of tags on a dataset to set row-level security. |
| ColumnGroups? | array | Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. |
| ImportMode? | enum | |
| DatasetParameters? | array | The parameter declarations of the dataset. |
| LogicalTableMap? | record | |
| AwsAccountId? | string | |
| DataSetUsageConfiguration? | object | The usage configuration to apply to child datasets that reference this dataset as a source. |
| DataPrepConfiguration? | object |
fn create()
Create a QuickSight DataSet
fn get(identifier: string)
Get a QuickSight DataSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DataSet |
fn update()
Update a QuickSight DataSet
fn delete(identifier: string)
Delete a QuickSight DataSet
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DataSet |
fn sync()
Sync QuickSight DataSet state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight DataSet 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)— QuickSight DataSet resource state
@swamp/aws/quicksight/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. |
| ErrorInfo? | object | Error information for the data source creation or update. |
| FolderArns? | array | |
| Name | string | |
| DataSourceParameters? | object | The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. |
| Type | enum | |
| VpcConnectionProperties? | object | VPC connection properties. |
| AlternateDataSourceParameters? | array | A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this exi |
| AwsAccountId? | string | |
| Permissions? | array | |
| SslProperties? | object | Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source. |
| Credentials? | object | Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null. |
| DataSourceId? | string | |
| Tags? | array |
fn create()
Create a QuickSight DataSource
fn get(identifier: string)
Get a QuickSight DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DataSource |
fn update()
Update a QuickSight DataSource
fn delete(identifier: string)
Delete a QuickSight DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DataSource |
fn sync()
Sync QuickSight DataSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight 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)— QuickSight DataSource resource state
@swamp/aws/quicksight/dlpsettingv2026.10.23.1dlpsetting.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. |
| AwsAccountId? | string | |
| DlpSettingId | string | |
| Enabled | boolean | |
| Name | string | |
| ProviderConfig | object | |
| ProviderOutageAction | enum | |
| ProviderType | enum | |
| Tags? | array |
fn create()
Create a QuickSight DLPSetting
fn get(identifier: string)
Get a QuickSight DLPSetting
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DLPSetting |
fn update()
Update a QuickSight DLPSetting
fn delete(identifier: string)
Delete a QuickSight DLPSetting
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight DLPSetting |
fn sync()
Sync QuickSight DLPSetting state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight DLPSetting 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)— QuickSight DLPSetting resource state
@swamp/aws/quicksight/flowv2026.10.25.1flow.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. |
| AwsAccountId | string | |
| Description? | string | |
| FlowDefinition | unknown | |
| Name | string | |
| Permissions? | array |
fn create()
Create a QuickSight Flow
fn get(identifier: string)
Get a QuickSight Flow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Flow |
fn update()
Update a QuickSight Flow
fn delete(identifier: string)
Delete a QuickSight Flow
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Flow |
fn sync()
Sync QuickSight Flow state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Flow 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)— QuickSight Flow resource state
@swamp/aws/quicksight/folderv2026.10.23.1folder.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. |
| AwsAccountId? | string | |
| FolderId? | string | |
| FolderType? | enum | |
| Name? | string | |
| ParentFolderArn? | string | |
| Permissions? | array | |
| SharingModel? | enum | |
| Tags? | array |
fn create()
Create a QuickSight Folder
fn get(identifier: string)
Get a QuickSight Folder
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Folder |
fn update()
Update a QuickSight Folder
fn delete(identifier: string)
Delete a QuickSight Folder
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Folder |
fn sync()
Sync QuickSight Folder state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Folder 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)— QuickSight Folder resource state
@swamp/aws/quicksight/groupv2026.10.23.1group.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. |
| GroupName | string | A name for the group. |
| Description? | string | A description for the group. |
| Namespace | string | The namespace that you want the group to be a part of. |
fn create()
Create a QuickSight Group
fn get(identifier: string)
Get a QuickSight Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Group |
fn update()
Update a QuickSight Group
fn delete(identifier: string)
Delete a QuickSight Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Group |
fn sync()
Sync QuickSight Group state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Group 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)— QuickSight Group resource state
@swamp/aws/quicksight/knowledge-basev2026.10.23.1knowledge_base.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. |
| AccessControlConfiguration? | object | |
| AwsAccountId | string | |
| DataSourceArn | string | |
| Description? | string | |
| IsEmailNotificationOptedForIngestionFailures? | boolean | |
| KnowledgeBaseConfiguration | object | |
| KnowledgeBaseId | string | |
| MediaExtractionConfiguration? | object | |
| Name | string | |
| Permissions? | array | |
| PrimaryOwnerArn? | string | |
| Tags? | array |
fn create()
Create a QuickSight KnowledgeBase
fn get(identifier: string)
Get a QuickSight KnowledgeBase
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight KnowledgeBase |
fn update()
Update a QuickSight KnowledgeBase
fn delete(identifier: string)
Delete a QuickSight KnowledgeBase
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight KnowledgeBase |
fn sync()
Sync QuickSight KnowledgeBase state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight KnowledgeBase 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)— QuickSight KnowledgeBase resource state
@swamp/aws/quicksight/limits-profilev2026.10.23.1limits_profile.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. |
| AccountId | string | |
| Description? | string | |
| ProfileName | string | |
| ResourceLimits | record |
fn create()
Create a QuickSight LimitsProfile
fn get(identifier: string)
Get a QuickSight LimitsProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight LimitsProfile |
fn update()
Update a QuickSight LimitsProfile
fn delete(identifier: string)
Delete a QuickSight LimitsProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight LimitsProfile |
fn sync()
Sync QuickSight LimitsProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight LimitsProfile 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)— QuickSight LimitsProfile resource state
@swamp/aws/quicksight/oauth-client-applicationv2026.10.23.1oauth_client_application.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. |
| OAuthClientApplicationId | string | |
| Name | string | |
| OAuthClientAuthenticationType | enum | |
| ClientId? | string | |
| ClientSecret? | string | |
| OAuthTokenEndpointUrl | string | |
| OAuthAuthorizationEndpointUrl? | string | |
| OAuthScopes? | string | |
| DataSourceType? | enum | |
| IdentityProviderVpcConnectionProperties? | object | |
| Tags? | array |
fn create()
Create a QuickSight OAuthClientApplication
fn get(identifier: string)
Get a QuickSight OAuthClientApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight OAuthClientApplication |
fn update()
Update a QuickSight OAuthClientApplication
fn delete(identifier: string)
Delete a QuickSight OAuthClientApplication
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight OAuthClientApplication |
fn sync()
Sync QuickSight OAuthClientApplication state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight OAuthClientApplication 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)— QuickSight OAuthClientApplication resource state
@swamp/aws/quicksight/refresh-schedulev2026.10.25.1refresh_schedule.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. |
| AwsAccountId? | string | |
| DataSetId? | string | |
| Schedule? | object |
fn create()
Create a QuickSight RefreshSchedule
fn get(identifier: string)
Get a QuickSight RefreshSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight RefreshSchedule |
fn update()
Update a QuickSight RefreshSchedule
fn delete(identifier: string)
Delete a QuickSight RefreshSchedule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight RefreshSchedule |
fn sync()
Sync QuickSight RefreshSchedule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight RefreshSchedule 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)— QuickSight RefreshSchedule resource state
@swamp/aws/quicksight/spacev2026.10.23.1space.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. |
| AwsAccountId | string | The ID of the Amazon Web Services account where the space is being created. |
| SpaceId | string | The unique identifier for the space. |
| Name | string | The display name of the space. |
| Description? | string | A description of the space. |
| Permissions? | array | A list of permissions granted on the space. |
| Resources? | array | A list of QuickSight resources attached to the space. |
| Tags? | array | A list of key-value pairs to associate with the space resource. |
fn create()
Create a QuickSight Space
fn get(identifier: string)
Get a QuickSight Space
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Space |
fn update()
Update a QuickSight Space
fn delete(identifier: string)
Delete a QuickSight Space
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Space |
fn sync()
Sync QuickSight Space state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Space 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)— QuickSight Space resource state
@swamp/aws/quicksight/templatev2026.10.25.1template.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. |
| VersionDescription? | string | |
| SourceEntity? | object | The source entity of the template. |
| Definition? | object | |
| ValidationStrategy? | object | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors. |
| Name? | string | |
| Version? | object | A version of a template. |
| AwsAccountId | string | |
| Permissions? | array | |
| Tags? | array | |
| TemplateId | string |
fn create()
Create a QuickSight Template
fn get(identifier: string)
Get a QuickSight Template
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Template |
fn update()
Update a QuickSight Template
fn delete(identifier: string)
Delete a QuickSight Template
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Template |
fn sync()
Sync QuickSight Template state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Template 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)— QuickSight Template resource state
@swamp/aws/quicksight/themev2026.10.25.1theme.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. |
| AwsAccountId | string | |
| BaseThemeId | string | |
| Configuration | object | The theme configuration. This configuration contains all of the display properties for a theme. |
| Name | string | |
| Permissions? | array | |
| Tags? | array | |
| ThemeId | string | |
| Version? | object | A version of a theme. |
| VersionDescription? | string |
fn create()
Create a QuickSight Theme
fn get(identifier: string)
Get a QuickSight Theme
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Theme |
fn update()
Update a QuickSight Theme
fn delete(identifier: string)
Delete a QuickSight Theme
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Theme |
fn sync()
Sync QuickSight Theme state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Theme 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)— QuickSight Theme resource state
@swamp/aws/quicksight/topicv2026.10.23.1topic.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. |
| AwsAccountId? | string | |
| ConfigOptions? | object | |
| CustomInstructions? | object | Instructions that provide additional guidance and context for response generation. |
| DataSets? | array | |
| Description? | string | |
| FolderArns? | array | |
| Name? | string | |
| Tags? | array | |
| TopicId? | string | |
| UserExperienceVersion? | enum |
fn create()
Create a QuickSight Topic
fn get(identifier: string)
Get a QuickSight Topic
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Topic |
fn update()
Update a QuickSight Topic
fn delete(identifier: string)
Delete a QuickSight Topic
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight Topic |
fn sync()
Sync QuickSight Topic state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight Topic 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)— QuickSight Topic resource state
@swamp/aws/quicksight/topic-v2v2026.10.23.1topic_v2.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. |
| AwsAccountId? | string | |
| CustomInstructions? | object | |
| DataSets? | array | |
| DataSetRelations? | array | |
| Description? | string | |
| FolderArns? | array | |
| Name? | string | |
| Permissions? | array | |
| Tags? | array | |
| TopicId? | string |
fn create()
Create a QuickSight TopicV2
fn get(identifier: string)
Get a QuickSight TopicV2
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight TopicV2 |
fn update()
Update a QuickSight TopicV2
fn delete(identifier: string)
Delete a QuickSight TopicV2
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight TopicV2 |
fn sync()
Sync QuickSight TopicV2 state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight TopicV2 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)— QuickSight TopicV2 resource state
@swamp/aws/quicksight/vpcconnectionv2026.10.23.1vpcconnection.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. |
| AvailabilityStatus? | enum | |
| AwsAccountId? | string | |
| DnsResolvers? | array | |
| Name? | string | |
| RoleArn? | string | |
| SecurityGroupIds? | array | |
| SubnetIds? | array | |
| Tags? | array | |
| VPCConnectionId? | string |
fn create()
Create a QuickSight VPCConnection
fn get(identifier: string)
Get a QuickSight VPCConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight VPCConnection |
fn update()
Update a QuickSight VPCConnection
fn delete(identifier: string)
Delete a QuickSight VPCConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the QuickSight VPCConnection |
fn sync()
Sync QuickSight VPCConnection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List QuickSight VPCConnection 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)— QuickSight VPCConnection resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: action_connector, agent, analysis, approval_policy, assignment, brand, custom_permissions, customization, dlpsetting, dashboard, data_set, data_source, flow, folder, group, knowledge_base, limits_profile, oauth_client_application, refresh_schedule, space, template, theme, topic, topic_v2, vpcconnection
2026.10.14.1AGPL-3.0-or-later(was none)
- Added: assignment, brand, group
Added 3 behaviors
2026.10.13.1
- Updated: action_connector, agent, analysis, approval_policy, custom_permissions, customization, dlpsetting, dashboard, data_set, data_source, flow, folder, knowledge_base, limits_profile, oauth_client_application, refresh_schedule, space, template, theme, topic, topic_v2, vpcconnection
2026.10.08.1
2026.10.06.1
2026.10.04.1
- Updated: analysis, dashboard, template
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
- Updated: data_source
2026.09.24.1
- Updated: analysis, dashboard, template, theme
2026.09.23.1
2026.09.22.1
05Stats
A
100 / 100
Downloads
136
Archive size
5.1 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