Package-level declarations
Types
Dataset reference.
A date-time parameter.
A decimal parameter.
Analysis error.
Describes the properties for a solid color
An integer parameter.
A list of Amazon QuickSight parameters and the list's override values.
Permission for the resource.
A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
The source entity of an analysis.
The source template of an analysis.
A string parameter.
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.
An ad hoc (one-time) filtering option.
The drill down options for data points in a dashbaord.
The data point menu options of a dashboard.
The data point tooltip options.
Dataset reference.
A date-time parameter.
A decimal parameter.
Dashboard error.
Determines if hidden fields are included in an exported dashboard.
Export to .csv option.
Determines whether or not hidden fields are visible on exported dashbaords.
Describes the properties for a solid color
An integer parameter.
A list of Amazon QuickSight parameters and the list's override values.
Dashboard publish options.
Permission for the resource.
A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
Sheet controls option.
The sheet layout maximization options of a dashbaord.
Dashboard source entity.
Dashboard source template.
A string parameter.
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.
Dashboard version.
The visual publish options of a visual in a dashboard
A calculated column for a dataset.
A transform operation that casts a column to a different type.
Metadata that contains a description for a column.
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
A tag for a column in a
TagColumnOperation
structure. This is a
variant type structure. For this structure to be valid, only one of the attributes can
be non-null.
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
A physical table type built from the results of the custom SQL query.
A dataset parameter.
A date time parameter for a dataset.
The default values of a date time parameter.
A decimal parameter for a dataset.
The default values of a decimal parameter.
A FieldFolder element is a folder that contains fields and nested subfolders.
A transform operation that filters rows based on a condition.
Geospatial column group that denotes a hierarchy.
The incremental refresh configuration for a dataset.
Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.
Metadata for a column that is used as the input of a transform operation.
An integer parameter for a dataset.
The default values of an integer parameter.
The instructions associated with a join.
Properties associated with the columns participating in a join.
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
The lookback window setup of an incremental refresh configuration.
The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.
Output column.
A transform operation that overrides the dataset parameter values that are defined in another dataset.
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
The refresh configuration of a dataset.
The refresh properties of a dataset.
A physical table type for relational data sources.
A transform operation that renames a column.
Permission for the resource.
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.
The configuration of tags on a dataset to set row-level security.
A set of rules associated with a tag.
A physical table type for an S3 data source.
A string parameter for a dataset.
The default values of a string parameter.
A transform operation that tags a column with additional information.
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
A transform operation that removes tags associated with a column.
Information about the format for a source file or files.
The usage configuration to apply to child datasets that reference this dataset as a source.
The parameters for OpenSearch.
The parameters for OpenSearch.
Parameters for Amazon Athena.
Parameters for Amazon Aurora.
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
The combination of user name and password that are used as credentials.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
The parameters that are required to connect to a Databricks data source.
Error information for the data source creation or update.
The parameters for an IAM Identity Center configuration.
Amazon S3 manifest file location.
The parameters for MariaDB.
The parameters for MySQL.
The parameters for Oracle.
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.
The parameters for PostgreSQL.
The parameters for Presto.
The parameters for Amazon RDS.
A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials
API. For more information on the redshift:GetClusterCredentials
API, see
GetClusterCredentials
.
The parameters for Amazon Redshift. The ClusterId
field can be blank if
Host
and Port
are both set. The Host
and Port
fields can be blank if the ClusterId
field is set.
Permission for the resource.
The parameters for S3.
The parameters for Snowflake.
The parameters for Spark.
The parameters for SQL Server.
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
The parameters that are required to connect to a Starburst data source.
The parameters for Teradata.
The parameters that are required to connect to a Trino data source.
VPC connection properties.
Permission for the resource.
Information about the schedule frequency.
The day scheduled for refresh.
A structure describing the name, data type, and geographic role of the columns.
The column group schema.
The column schema.
Dataset configuration.
Dataset reference.
Dataset schema.
List of errors that occurred when the template version creation failed.
Permission for the resource.
A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
The source analysis of the template.
The source entity of the template.
The source template of the template.
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.
A version of a template.
The display options for tile borders for visuals.
The theme configuration. This configuration contains all of the display properties for a theme.
The theme colors that are used for data colors in charts. The colors description is a
hexadecimal color code that consists of six alphanumerical characters, prefixed with
#
, for example #37BFF5.
Theme error.
The display options for gutter spacing between tiles on a sheet.
The display options for margins around the outside edge of sheets.
Permission for the resource.
The theme display options for sheets.
The display options for the layout of tiles on a sheet.
Display options related to tiles on a sheet.
The theme colors that apply to UI and to charts, excluding data colors. The colors
description is a hexadecimal color code that consists of six alphanumerical characters,
prefixed with #
, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User
Guide.
A version of a theme.
Model for configuration of a Topic
The structure that contains information about a network interface.