Skip to main content

@swamp/aws/quicksight

v2026.04.23.3

AWS QUICKSIGHT infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsquicksightcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/quicksight

@swamp/aws/quicksight/action-connectorv2026.04.23.2action_connector.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ActionConnectorIdstring
AuthenticationConfig?object
AwsAccountIdstring
Description?string
Namestring
Permissions?array
Tags?array
Typeenum
VpcConnectionArn?string
createCreate a QuickSight ActionConnector
getGet a QuickSight ActionConnector
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight ActionConnector
updateUpdate a QuickSight ActionConnector
deleteDelete a QuickSight ActionConnector
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight ActionConnector
syncSync QuickSight ActionConnector state from AWS

Resources

state(infinite)— QuickSight ActionConnector resource state
@swamp/aws/quicksight/analysisv2026.04.23.2analysis.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Status?enum
Parameters?objectA list of Amazon QuickSight parameters and the list's override values.
SourceEntity?objectThe source entity of an analysis.
ThemeArn?stringThe ARN of the theme of the analysis.
Definition?object
ValidationStrategy?objectThe 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
NamestringThe descriptive name of the analysis.
Errors?arrayErrors associated with the analysis.
AnalysisIdstring
AwsAccountIdstring
Permissions?array
Tags?array
Sheets?arrayA list of the associated sheets with the unique identifier and name of each sheet.
createCreate a QuickSight Analysis
getGet a QuickSight Analysis
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Analysis
updateUpdate a QuickSight Analysis
deleteDelete a QuickSight Analysis
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Analysis
syncSync QuickSight Analysis state from AWS

Resources

state(infinite)— QuickSight Analysis resource state
@swamp/aws/quicksight/custom-permissionsv2026.04.23.2custom_permissions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AwsAccountIdstring
Capabilities?object
CustomPermissionsNamestring
Tags?array
createCreate a QuickSight CustomPermissions
getGet a QuickSight CustomPermissions
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight CustomPermissions
updateUpdate a QuickSight CustomPermissions
deleteDelete a QuickSight CustomPermissions
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight CustomPermissions
syncSync QuickSight CustomPermissions state from AWS

Resources

state(infinite)— QuickSight CustomPermissions resource state
@swamp/aws/quicksight/dashboardv2026.04.23.2dashboard.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Parameters?objectA list of Amazon QuickSight parameters and the list's override values.
VersionDescription?string
SourceEntity?objectDashboard source entity.
ThemeArn?string
Definition?object
ValidationStrategy?objectThe 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
DashboardIdstring
LinkSharingConfiguration?object
Namestring
DashboardPublishOptions?objectDashboard publish options.
Version?objectDashboard version.
AwsAccountIdstring
Permissions?array
LinkEntities?array
Tags?array
createCreate a QuickSight Dashboard
getGet a QuickSight Dashboard
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Dashboard
updateUpdate a QuickSight Dashboard
deleteDelete a QuickSight Dashboard
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Dashboard
syncSync QuickSight Dashboard state from AWS

Resources

state(infinite)— QuickSight Dashboard resource state
@swamp/aws/quicksight/data-setv2026.04.23.2data_set.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
FolderArns?arrayWhen you create the dataset, Amazon QuickSight adds the dataset to these folders.
RowLevelPermissionDataSet?objectInformation 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?objectWait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.
ColumnLevelPermissionRules?arrayA set of one or more definitions of a ColumnLevelPermissionRule .
Name?stringThe display name for the dataset.
Permissions?arrayA list of resource permissions on the dataset.
UseAs?enum
Tags?arrayContains 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?objectThe refresh properties of a dataset.
RowLevelPermissionTagConfiguration?objectThe configuration of tags on a dataset to set row-level security.
ColumnGroups?arrayGroupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
ImportMode?enum
DatasetParameters?arrayThe parameter declarations of the dataset.
LogicalTableMap?record
AwsAccountId?string
DataSetUsageConfiguration?objectThe usage configuration to apply to child datasets that reference this dataset as a source.
DataPrepConfiguration?object
createCreate a QuickSight DataSet
getGet a QuickSight DataSet
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight DataSet
updateUpdate a QuickSight DataSet
deleteDelete a QuickSight DataSet
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight DataSet
syncSync QuickSight DataSet state from AWS

Resources

state(infinite)— QuickSight DataSet resource state
@swamp/aws/quicksight/data-sourcev2026.04.23.2data_source.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ErrorInfo?objectError information for the data source creation or update.
FolderArns?array
Namestring
DataSourceParameters?objectThe 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.
Typeenum
VpcConnectionProperties?objectVPC connection properties.
AlternateDataSourceParameters?arrayA 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?objectSecure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
Credentials?objectData 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
createCreate a QuickSight DataSource
getGet a QuickSight DataSource
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight DataSource
updateUpdate a QuickSight DataSource
deleteDelete a QuickSight DataSource
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight DataSource
syncSync QuickSight DataSource state from AWS

Resources

state(infinite)— QuickSight DataSource resource state
@swamp/aws/quicksight/folderv2026.04.23.2folder.ts

Global Arguments

ArgumentTypeDescription
namestringInstance 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
createCreate a QuickSight Folder
getGet a QuickSight Folder
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Folder
updateUpdate a QuickSight Folder
deleteDelete a QuickSight Folder
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Folder
syncSync QuickSight Folder state from AWS

Resources

state(infinite)— QuickSight Folder resource state
@swamp/aws/quicksight/refresh-schedulev2026.04.23.2refresh_schedule.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AwsAccountId?string
DataSetId?string
Schedule?object
createCreate a QuickSight RefreshSchedule
getGet a QuickSight RefreshSchedule
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight RefreshSchedule
updateUpdate a QuickSight RefreshSchedule
deleteDelete a QuickSight RefreshSchedule
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight RefreshSchedule
syncSync QuickSight RefreshSchedule state from AWS

Resources

state(infinite)— QuickSight RefreshSchedule resource state
@swamp/aws/quicksight/templatev2026.04.23.2template.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
VersionDescription?string
SourceEntity?objectThe source entity of the template.
Definition?object
ValidationStrategy?objectThe 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?objectA version of a template.
AwsAccountIdstring
Permissions?array
Tags?array
TemplateIdstring
createCreate a QuickSight Template
getGet a QuickSight Template
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Template
updateUpdate a QuickSight Template
deleteDelete a QuickSight Template
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Template
syncSync QuickSight Template state from AWS

Resources

state(infinite)— QuickSight Template resource state
@swamp/aws/quicksight/themev2026.04.23.2theme.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AwsAccountIdstring
BaseThemeIdstring
ConfigurationobjectThe theme configuration. This configuration contains all of the display properties for a theme.
Namestring
Permissions?array
Tags?array
ThemeIdstring
Version?objectA version of a theme.
VersionDescription?string
createCreate a QuickSight Theme
getGet a QuickSight Theme
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Theme
updateUpdate a QuickSight Theme
deleteDelete a QuickSight Theme
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Theme
syncSync QuickSight Theme state from AWS

Resources

state(infinite)— QuickSight Theme resource state
@swamp/aws/quicksight/topicv2026.04.23.2topic.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AwsAccountId?string
ConfigOptions?objectModel for configuration of a Topic
CustomInstructions?object
DataSets?array
Description?string
FolderArns?array
Name?string
Tags?array
TopicId?string
UserExperienceVersion?enum
createCreate a QuickSight Topic
getGet a QuickSight Topic
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Topic
updateUpdate a QuickSight Topic
deleteDelete a QuickSight Topic
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight Topic
syncSync QuickSight Topic state from AWS

Resources

state(infinite)— QuickSight Topic resource state
@swamp/aws/quicksight/vpcconnectionv2026.04.23.2vpcconnection.ts

Global Arguments

ArgumentTypeDescription
namestringInstance 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
createCreate a QuickSight VPCConnection
getGet a QuickSight VPCConnection
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight VPCConnection
updateUpdate a QuickSight VPCConnection
deleteDelete a QuickSight VPCConnection
ArgumentTypeDescription
identifierstringThe primary identifier of the QuickSight VPCConnection
syncSync QuickSight VPCConnection state from AWS

Resources

state(infinite)— QuickSight VPCConnection resource state