logo
Expand description

Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

If you’re using the service, you’re probably looking for QuicksightClient and Quicksight.

Structs

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

The QuickSight settings associated with your AWS account.

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

Ad hoc (one-time) filtering option.

Amazon Elasticsearch Service parameters.

Metadata structure for an analysis in Amazon QuickSight

A metadata error structure for an analysis.

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.

Amazon Athena parameters.

Amazon Aurora parameters.

Amazon Aurora with PostgreSQL compatibility parameters.

AWS IoT Analytics parameters.

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 request object for this operation.

The response object for this operation.

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

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.

A date-time parameter.

A decimal parameter.

Error information for the SPICE ingestion of a dataset.

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.

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

Searches a folder by a filter.

A summary of the folder.

Geospatial column group that denotes a hierarchy.

Output returned from the GetDashboardEmbedUrl operation.

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

Jira parameters.

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.

Amazon S3 manifest file location.

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

MariaDB parameters.

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

MySQL parameters.

Errors that occur during namespace creation.

The error type.

Oracle parameters.

Output column.

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

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.

PostgreSQL parameters.

Presto parameters.

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.

A client for the Amazon QuickSight API.

Amazon RDS parameters.

Amazon Redshift parameters. 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.

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 option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

S3 parameters.

A physical table type for an S3 data source.

ServiceNow parameters.

A sheet, which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. 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.

Snowflake parameters.

Spark parameters.

SQL Server parameters.

Secure Socket Layer (SSL) properties that apply when 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 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.

You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing 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.

Teradata parameters.

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.

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.

Twitter parameters.

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.

Information about the format for a source file or files.

A registered user of Amazon QuickSight.

VPC connection properties.

Enums

Errors returned by CancelIngestion

Errors returned by CreateAccountCustomization

Errors returned by CreateAnalysis

Errors returned by CreateDashboard

Errors returned by CreateDataSet

Errors returned by CreateDataSource

Errors returned by CreateFolder

Errors returned by CreateFolderMembership

Errors returned by CreateGroup

Errors returned by CreateGroupMembership

Errors returned by CreateIAMPolicyAssignment

Errors returned by CreateIngestion

Errors returned by CreateNamespace

Errors returned by CreateTemplateAlias

Errors returned by CreateTemplate

Errors returned by CreateThemeAlias

Errors returned by CreateTheme

Errors returned by DeleteAccountCustomization

Errors returned by DeleteAnalysis

Errors returned by DeleteDashboard

Errors returned by DeleteDataSet

Errors returned by DeleteDataSource

Errors returned by DeleteFolder

Errors returned by DeleteFolderMembership

Errors returned by DeleteGroup

Errors returned by DeleteGroupMembership

Errors returned by DeleteIAMPolicyAssignment

Errors returned by DeleteNamespace

Errors returned by DeleteTemplateAlias

Errors returned by DeleteTemplate

Errors returned by DeleteThemeAlias

Errors returned by DeleteTheme

Errors returned by DeleteUserByPrincipalId

Errors returned by DeleteUser

Errors returned by DescribeAccountCustomization

Errors returned by DescribeAccountSettings

Errors returned by DescribeAnalysis

Errors returned by DescribeAnalysisPermissions

Errors returned by DescribeDashboard

Errors returned by DescribeDashboardPermissions

Errors returned by DescribeDataSet

Errors returned by DescribeDataSetPermissions

Errors returned by DescribeDataSource

Errors returned by DescribeDataSourcePermissions

Errors returned by DescribeFolder

Errors returned by DescribeFolderPermissions

Errors returned by DescribeFolderResolvedPermissions

Errors returned by DescribeGroup

Errors returned by DescribeIAMPolicyAssignment

Errors returned by DescribeIngestion

Errors returned by DescribeNamespace

Errors returned by DescribeTemplateAlias

Errors returned by DescribeTemplate

Errors returned by DescribeTemplatePermissions

Errors returned by DescribeThemeAlias

Errors returned by DescribeTheme

Errors returned by DescribeThemePermissions

Errors returned by DescribeUser

Errors returned by GetDashboardEmbedUrl

Errors returned by GetSessionEmbedUrl

Errors returned by ListAnalyses

Errors returned by ListDashboardVersions

Errors returned by ListDashboards

Errors returned by ListDataSets

Errors returned by ListDataSources

Errors returned by ListFolderMembers

Errors returned by ListFolders

Errors returned by ListGroupMemberships

Errors returned by ListGroups

Errors returned by ListIAMPolicyAssignments

Errors returned by ListIAMPolicyAssignmentsForUser

Errors returned by ListIngestions

Errors returned by ListNamespaces

Errors returned by ListTagsForResource

Errors returned by ListTemplateAliases

Errors returned by ListTemplateVersions

Errors returned by ListTemplates

Errors returned by ListThemeAliases

Errors returned by ListThemeVersions

Errors returned by ListThemes

Errors returned by ListUserGroups

Errors returned by ListUsers

Errors returned by RegisterUser

Errors returned by RestoreAnalysis

Errors returned by SearchAnalyses

Errors returned by SearchDashboards

Errors returned by SearchFolders

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateAccountCustomization

Errors returned by UpdateAccountSettings

Errors returned by UpdateAnalysis

Errors returned by UpdateAnalysisPermissions

Errors returned by UpdateDashboard

Errors returned by UpdateDashboardPermissions

Errors returned by UpdateDashboardPublishedVersion

Errors returned by UpdateDataSet

Errors returned by UpdateDataSetPermissions

Errors returned by UpdateDataSource

Errors returned by UpdateDataSourcePermissions

Errors returned by UpdateFolder

Errors returned by UpdateFolderPermissions

Errors returned by UpdateGroup

Errors returned by UpdateIAMPolicyAssignment

Errors returned by UpdateTemplateAlias

Errors returned by UpdateTemplate

Errors returned by UpdateTemplatePermissions

Errors returned by UpdateThemeAlias

Errors returned by UpdateTheme

Errors returned by UpdateThemePermissions

Errors returned by UpdateUser

Traits

Trait representing the capabilities of the Amazon QuickSight API. Amazon QuickSight clients implement this trait.