Aws/quicksight
@swamp/aws/quicksightv2026.05.29.1
01README
AWS QUICKSIGHT infrastructure models
02Release Notes
- Updated: custom_permissions
03Models
@swamp/aws/quicksight/action-connectorv2026.04.23.2action_connector.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight ActionConnector resource state
@swamp/aws/quicksight/analysisv2026.05.27.1analysis.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Status? | enum | |
| Parameters? | object | A list of Amazon QuickSight 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
Resources
state(infinite)— QuickSight Analysis resource state
@swamp/aws/quicksight/custom-permissionsv2026.05.29.1custom_permissions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight CustomPermissions resource state
@swamp/aws/quicksight/dashboardv2026.05.27.1dashboard.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| Parameters? | object | A list of Amazon QuickSight 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
Resources
state(infinite)— QuickSight Dashboard resource state
@swamp/aws/quicksight/data-setv2026.05.15.1data_set.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight DataSet resource state
@swamp/aws/quicksight/data-sourcev2026.05.15.1data_source.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight DataSource resource state
@swamp/aws/quicksight/folderv2026.04.23.2folder.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight Folder resource state
@swamp/aws/quicksight/refresh-schedulev2026.04.23.2refresh_schedule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight RefreshSchedule resource state
@swamp/aws/quicksight/templatev2026.05.27.1template.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight Template resource state
@swamp/aws/quicksight/themev2026.04.23.2theme.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight Theme resource state
@swamp/aws/quicksight/topicv2026.04.23.2topic.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| AwsAccountId? | string | |
| ConfigOptions? | object | Model for configuration of a Topic |
| CustomInstructions? | object | |
| 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
Resources
state(infinite)— QuickSight Topic resource state
@swamp/aws/quicksight/vpcconnectionv2026.04.23.2vpcconnection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| 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
Resources
state(infinite)— QuickSight VPCConnection resource state
04Previous Versions
2026.05.27.1May 27, 2026
- Updated: analysis, dashboard, template
2026.05.15.1May 15, 2026
- Updated: data_set, data_source
2026.04.23.3Apr 23, 2026
2026.04.23.2Apr 23, 2026
- Updated: action_connector, analysis, custom_permissions, dashboard, data_set, data_source, folder, refresh_schedule, template, theme, topic, vpcconnection
2026.04.03.3Apr 3, 2026
- Updated: action_connector, analysis, custom_permissions, dashboard, data_set, data_source, folder, refresh_schedule, template, theme, topic, vpcconnection
2026.04.03.1Apr 3, 2026
- Updated: data_set, data_source
2026.03.25.1Mar 25, 2026
- Updated: custom_permissions
2026.03.19.1Mar 19, 2026
- Updated: action_connector, analysis, custom_permissions, dashboard, data_set, data_source, folder, refresh_schedule, template, theme, topic, vpcconnection
2026.03.16.1Mar 16, 2026
- Updated: action_connector, analysis, custom_permissions, dashboard, data_set, data_source, folder, refresh_schedule, template, theme, topic, vpcconnection
2026.03.10.5Mar 10, 2026
05Stats
B
85 / 100
Downloads
0
Archive size
3.0 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 types1/1earned
- Dependencies pass trust audit0/2missing
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels