Expand description

Data structures used by operation inputs/outputs.

Modules

See Tag

Structs

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

The Amazon QuickSight settings associated with your Amazon Web Services account.

The active Identity and Access Management (IAM) policy assignment.

Ad hoc (one-time) filtering option.

The parameters for OpenSearch.

The parameters for OpenSearch.

Metadata structure for an analysis in Amazon QuickSight

Analysis error.

A filter that you apply when searching for one or more analyses.

The source entity of an analysis.

The source template of an analysis.

The summary metadata that describes an analysis.

Information about the dashboard that you want to embed.

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

Parameters for Amazon Athena.

Parameters for Amazon Aurora.

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

The parameters for IoT Analytics.

The display options for tile borders for visuals.

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 structure describing the name, data type, and geographic role of the columns.

The column group schema.

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.

The column schema.

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.

The combination of user name and password that are used as credentials.

A physical table type built from the results of the custom SQL query.

Dashboard.

Dashboard error.

Dashboard publish options.

A filter that you apply when searching for dashboards.

Dashboard source entity.

Dashboard source template.

Dashboard summary.

Dashboard version.

Dashboard version summary.

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.

Dataset.

Dataset configuration.

Dataset reference.

Dataset schema.

Dataset summary.

The usage configuration to apply to child datasets that reference this dataset as a source.

The structure of a data source.

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Error information for the data source creation or update.

A date-time parameter.

A decimal parameter.

Error information for the SPICE ingestion of a dataset.

The required parameters for connecting to an Exasol data source.

Export to .csv option.

A FieldFolder element is a folder that contains fields and nested subfolders.

A transform operation that filters rows based on a condition.

A folder in Amazon QuickSight.

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

A filter to use to search a Amazon QuickSight folder.

A summary of information about an existing Amazon QuickSight folder.

Geospatial column group that denotes a hierarchy.

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .

The display options for gutter spacing between tiles on a sheet.

An Identity and Access Management (IAM) policy assignment.

IAM policy assignment summary.

Information about the SPICE ingestion for a dataset.

Metadata for a column that is used as the input of a transform operation.

An integer parameter.

The parameters for Jira.

The instructions associated with a join.

Properties associated with the columns participating in a join.

A structure that contains the configuration of a shareable link to the dashboard.

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.

Amazon S3 manifest file location.

The display options for margins around the outside edge of sheets.

The parameters for MariaDB.

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

The parameters for MySQL.

Errors that occur during namespace creation.

The error type.

The parameters for Oracle.

Output column.

A list of Amazon QuickSight parameters and the list's override values.

The parameters for PostgreSQL.

The parameters for Presto.

A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.

Information about a queued dataset SPICE ingestion.

The parameters for Amazon RDS.

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.

Information about the dashboard you want to embed.

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

Information about the Q search bar embedding experience.

Information about the Amazon QuickSight console that you want to embed.

A physical table type for relational data sources.

A transform operation that renames a column.

Permission for the resource.

Information about rows for a data set SPICE ingestion.

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 configuration of tags on a dataset to set row-level security.

A set of rules associated with a tag.

The parameters for S3.

A physical table type for an S3 data source.

The parameters for ServiceNow.

The key-value pair used for the row-level security tags feature.

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 theme display options for sheets.

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.

A string parameter.

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

A transform operation that tags a column with additional information.

A template object. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

The template alias.

List of errors that occurred when the template version creation failed.

The source analysis of the template.

The source entity of the template.

The source template of the template.

The template summary.

A version of a template.

The template version.

The parameters for Teradata.

Summary information about a theme.

An alias for a theme.

The theme configuration. This configuration contains all of the display properties for a theme.

Theme error.

The theme summary.

A version of a theme.

The theme version.

The display options for the layout of tiles on a sheet.

Display options related to tiles on a sheet.

The parameters for Twitter.

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 transform operation that removes tags associated with a column.

Information about the format for a source file or files.

A registered user of Amazon QuickSight.

VPC connection properties.

Enums

Note: DataSourceErrorInfoType::Unknown has been renamed to ::UnknownValue.

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.

This defines the type of ingestion request. This is returned as part of create ingestion response.

This defines the type of ingestion user wants to trigger. This is part of create ingestion request.

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 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.