Expand description
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§
- Account
Customization The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
- Account
Settings The QuickSight settings associated with your AWS account.
- ActiveIAM
Policy Assignment The active AWS Identity and Access Management (IAM) policy assignment.
- AdHoc
Filtering Option Ad hoc (one-time) filtering option.
- Amazon
Elasticsearch Parameters Amazon Elasticsearch Service parameters.
- Analysis
Metadata structure for an analysis in Amazon QuickSight
- Analysis
Error A metadata error structure for an analysis.
- Analysis
Search Filter A filter that you apply when searching for one or more analyses.
- Analysis
Source Entity The source entity of an analysis.
- Analysis
Source Template The source template of an analysis.
- Analysis
Summary The summary metadata that describes an analysis.
- Athena
Parameters Amazon Athena parameters.
- Aurora
Parameters Amazon Aurora parameters.
- Aurora
Postgre SqlParameters Amazon Aurora with PostgreSQL compatibility parameters.
- AwsIot
Analytics Parameters AWS IoT Analytics parameters.
- Border
Style The display options for tile borders for visuals.
- Calculated
Column A calculated column for a dataset.
- Cancel
Ingestion Request - Cancel
Ingestion Response - Cast
Column Type Operation A transform operation that casts a column to a different type.
- Column
Description Metadata that contains a description for a column.
- Column
Group 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.
- Column
Group Column Schema A structure describing the name, data type, and geographic role of the columns.
- Column
Group Schema The column group schema.
- Column
Level Permission Rule 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.
- Column
Schema The column schema.
- Column
Tag 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.
- Create
Account Customization Request - Create
Account Customization Response - Create
Analysis Request - Create
Analysis Response - Create
Columns Operation A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
- Create
Dashboard Request - Create
Dashboard Response - Create
Data SetRequest - Create
Data SetResponse - Create
Data Source Request - Create
Data Source Response - Create
Folder Membership Request - Create
Folder Membership Response - Create
Folder Request - Create
Folder Response - Create
Group Membership Request - Create
Group Membership Response - Create
Group Request The request object for this operation.
- Create
Group Response The response object for this operation.
- CreateIAM
Policy Assignment Request - CreateIAM
Policy Assignment Response - Create
Ingestion Request - Create
Ingestion Response - Create
Namespace Request - Create
Namespace Response - Create
Template Alias Request - Create
Template Alias Response - Create
Template Request - Create
Template Response - Create
Theme Alias Request - Create
Theme Alias Response - Create
Theme Request - Create
Theme Response - Credential
Pair The combination of user name and password that are used as credentials.
- Custom
Sql A physical table type built from the results of the custom SQL query.
- Dashboard
Dashboard.
- Dashboard
Error Dashboard error.
- Dashboard
Publish Options Dashboard publish options.
- Dashboard
Search Filter A filter that you apply when searching for dashboards.
- Dashboard
Source Entity Dashboard source entity.
- Dashboard
Source Template Dashboard source template.
- Dashboard
Summary Dashboard summary.
- Dashboard
Version Dashboard version.
- Dashboard
Version Summary Dashboard version summary.
- Data
Color Palette 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.
- Data
SetConfiguration Dataset configuration.
- Data
SetReference Dataset reference.
- Data
SetSchema Dataset schema.
- Data
SetSummary Dataset summary.
- Data
Source The structure of a data source.
- Data
Source 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.
- Data
Source Error Info Error information for the data source creation or update.
- Data
Source Parameters 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.
- Date
Time Parameter A date-time parameter.
- Decimal
Parameter A decimal parameter.
- Delete
Account Customization Request - Delete
Account Customization Response - Delete
Analysis Request - Delete
Analysis Response - Delete
Dashboard Request - Delete
Dashboard Response - Delete
Data SetRequest - Delete
Data SetResponse - Delete
Data Source Request - Delete
Data Source Response - Delete
Folder Membership Request - Delete
Folder Membership Response - Delete
Folder Request - Delete
Folder Response - Delete
Group Membership Request - Delete
Group Membership Response - Delete
Group Request - Delete
Group Response - DeleteIAM
Policy Assignment Request - DeleteIAM
Policy Assignment Response - Delete
Namespace Request - Delete
Namespace Response - Delete
Template Alias Request - Delete
Template Alias Response - Delete
Template Request - Delete
Template Response - Delete
Theme Alias Request - Delete
Theme Alias Response - Delete
Theme Request - Delete
Theme Response - Delete
User ByPrincipal IdRequest - Delete
User ByPrincipal IdResponse - Delete
User Request - Delete
User Response - Describe
Account Customization Request - Describe
Account Customization Response - Describe
Account Settings Request - Describe
Account Settings Response - Describe
Analysis Permissions Request - Describe
Analysis Permissions Response - Describe
Analysis Request - Describe
Analysis Response - Describe
Dashboard Permissions Request - Describe
Dashboard Permissions Response - Describe
Dashboard Request - Describe
Dashboard Response - Describe
Data SetPermissions Request - Describe
Data SetPermissions Response - Describe
Data SetRequest - Describe
Data SetResponse - Describe
Data Source Permissions Request - Describe
Data Source Permissions Response - Describe
Data Source Request - Describe
Data Source Response - Describe
Folder Permissions Request - Describe
Folder Permissions Response - Describe
Folder Request - Describe
Folder Resolved Permissions Request - Describe
Folder Resolved Permissions Response - Describe
Folder Response - Describe
Group Request - Describe
Group Response - DescribeIAM
Policy Assignment Request - DescribeIAM
Policy Assignment Response - Describe
Ingestion Request - Describe
Ingestion Response - Describe
Namespace Request - Describe
Namespace Response - Describe
Template Alias Request - Describe
Template Alias Response - Describe
Template Permissions Request - Describe
Template Permissions Response - Describe
Template Request - Describe
Template Response - Describe
Theme Alias Request - Describe
Theme Alias Response - Describe
Theme Permissions Request - Describe
Theme Permissions Response - Describe
Theme Request - Describe
Theme Response - Describe
User Request - Describe
User Response - Error
Info Error information for the SPICE ingestion of a dataset.
- Export
ToCSV Option Export to .csv option.
- Field
Folder A FieldFolder element is a folder that contains fields and nested subfolders.
- Filter
Operation A transform operation that filters rows based on a condition.
- Folder
A folder.
- Folder
Member An asset in a folder, such as a dashboard, analysis, or dataset.
- Folder
Search Filter Searches a folder by a filter.
- Folder
Summary A summary of the folder.
- GeoSpatial
Column Group Geospatial column group that denotes a hierarchy.
- GetDashboard
Embed UrlRequest - GetDashboard
Embed UrlResponse Output returned from the
GetDashboardEmbedUrloperation.- GetSession
Embed UrlRequest - GetSession
Embed UrlResponse - Group
A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.
- Group
Member A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .
- Gutter
Style The display options for gutter spacing between tiles on a sheet.
- IAMPolicy
Assignment An AWS Identity and Access Management (IAM) policy assignment.
- IAMPolicy
Assignment Summary IAM policy assignment summary.
- Ingestion
Information about the SPICE ingestion for a dataset.
- Input
Column Metadata for a column that is used as the input of a transform operation.
- Integer
Parameter An integer parameter.
- Jira
Parameters Jira parameters.
- Join
Instruction The instructions associated with a join.
- Join
KeyProperties Properties associated with the columns participating in a join.
- List
Analyses Request - List
Analyses Response - List
Dashboard Versions Request - List
Dashboard Versions Response - List
Dashboards Request - List
Dashboards Response - List
Data Sets Request - List
Data Sets Response - List
Data Sources Request - List
Data Sources Response - List
Folder Members Request - List
Folder Members Response - List
Folders Request - List
Folders Response - List
Group Memberships Request - List
Group Memberships Response - List
Groups Request - List
Groups Response - ListIAM
Policy Assignments ForUser Request - ListIAM
Policy Assignments ForUser Response - ListIAM
Policy Assignments Request - ListIAM
Policy Assignments Response - List
Ingestions Request - List
Ingestions Response - List
Namespaces Request - List
Namespaces Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Template Aliases Request - List
Template Aliases Response - List
Template Versions Request - List
Template Versions Response - List
Templates Request - List
Templates Response - List
Theme Aliases Request - List
Theme Aliases Response - List
Theme Versions Request - List
Theme Versions Response - List
Themes Request - List
Themes Response - List
User Groups Request - List
User Groups Response - List
Users Request - List
Users Response - Logical
Table 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.
- Logical
Table Source 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.
- Manifest
File Location Amazon S3 manifest file location.
- Margin
Style The display options for margins around the outside edge of sheets.
- Maria
DbParameters MariaDB parameters.
- Member
IdArn Pair An object that consists of the member Amazon Resource Name (ARN) and member ID.
- MySql
Parameters MySQL parameters.
- Namespace
Error Errors that occur during namespace creation.
- Namespace
Info V2 The error type.
- Oracle
Parameters Oracle parameters.
- Output
Column Output column.
- Parameters
A list of QuickSight parameters and the list's override values.
- Physical
Table 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.
- Postgre
SqlParameters PostgreSQL parameters.
- Presto
Parameters Presto parameters.
- Project
Operation A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
- Queue
Info Information about a queued dataset SPICE ingestion.
- Quicksight
Client - A client for the Amazon QuickSight API.
- RdsParameters
Amazon RDS parameters.
- Redshift
Parameters Amazon Redshift parameters. The
ClusterIdfield can be blank ifHostandPortare both set. TheHostandPortfields can be blank if theClusterIdfield is set.- Register
User Request - Register
User Response - Relational
Table A physical table type for relational data sources.
- Rename
Column Operation A transform operation that renames a column.
- Resource
Permission Permission for the resource.
- Restore
Analysis Request - Restore
Analysis Response - RowInfo
Information about rows for a data set SPICE ingestion.
- RowLevel
Permission Data Set 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
PermissionPolicytoDENY_ACCESSis not supported for new RLS datasets.- S3Parameters
S3 parameters.
- S3Source
A physical table type for an S3 data source.
- Search
Analyses Request - Search
Analyses Response - Search
Dashboards Request - Search
Dashboards Response - Search
Folders Request - Search
Folders Response - Service
NowParameters ServiceNow parameters.
- Sheet
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 Sheet controls option.
- Sheet
Style The theme display options for sheets.
- Snowflake
Parameters Snowflake parameters.
- Spark
Parameters Spark parameters.
- SqlServer
Parameters SQL Server parameters.
- SslProperties
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
- String
Parameter A string parameter.
- Tag
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
- TagColumn
Operation A transform operation that tags a column with additional information.
- TagResource
Request - TagResource
Response - Template
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.
- Template
Alias The template alias.
- Template
Error List of errors that occurred when the template version creation failed.
- Template
Source Analysis The source analysis of the template.
- Template
Source Entity The source entity of the template.
- Template
Source Template The source template of the template.
- Template
Summary The template summary.
- Template
Version A version of a template.
- Template
Version Summary The template version.
- Teradata
Parameters Teradata parameters.
- Theme
Summary information about a theme.
- Theme
Alias An alias for a theme.
- Theme
Configuration The theme configuration. This configuration contains all of the display properties for a theme.
- Theme
Error Theme error.
- Theme
Summary The theme summary.
- Theme
Version A version of a theme.
- Theme
Version Summary The theme version.
- Tile
Layout Style The display options for the layout of tiles on a sheet.
- Tile
Style Display options related to tiles on a sheet.
- Transform
Operation 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 Twitter parameters.
- UIColor
Palette 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.- Untag
Resource Request - Untag
Resource Response - Update
Account Customization Request - Update
Account Customization Response - Update
Account Settings Request - Update
Account Settings Response - Update
Analysis Permissions Request - Update
Analysis Permissions Response - Update
Analysis Request - Update
Analysis Response - Update
Dashboard Permissions Request - Update
Dashboard Permissions Response - Update
Dashboard Published Version Request - Update
Dashboard Published Version Response - Update
Dashboard Request - Update
Dashboard Response - Update
Data SetPermissions Request - Update
Data SetPermissions Response - Update
Data SetRequest - Update
Data SetResponse - Update
Data Source Permissions Request - Update
Data Source Permissions Response - Update
Data Source Request - Update
Data Source Response - Update
Folder Permissions Request - Update
Folder Permissions Response - Update
Folder Request - Update
Folder Response - Update
Group Request - Update
Group Response - UpdateIAM
Policy Assignment Request - UpdateIAM
Policy Assignment Response - Update
Template Alias Request - Update
Template Alias Response - Update
Template Permissions Request - Update
Template Permissions Response - Update
Template Request - Update
Template Response - Update
Theme Alias Request - Update
Theme Alias Response - Update
Theme Permissions Request - Update
Theme Permissions Response - Update
Theme Request - Update
Theme Response - Update
User Request - Update
User Response - Upload
Settings Information about the format for a source file or files.
- User
A registered user of Amazon QuickSight.
- VpcConnection
Properties VPC connection properties.
Enums§
- Cancel
Ingestion Error - Errors returned by CancelIngestion
- Create
Account Customization Error - Errors returned by CreateAccountCustomization
- Create
Analysis Error - Errors returned by CreateAnalysis
- Create
Dashboard Error - Errors returned by CreateDashboard
- Create
Data SetError - Errors returned by CreateDataSet
- Create
Data Source Error - Errors returned by CreateDataSource
- Create
Folder Error - Errors returned by CreateFolder
- Create
Folder Membership Error - Errors returned by CreateFolderMembership
- Create
Group Error - Errors returned by CreateGroup
- Create
Group Membership Error - Errors returned by CreateGroupMembership
- CreateIAM
Policy Assignment Error - Errors returned by CreateIAMPolicyAssignment
- Create
Ingestion Error - Errors returned by CreateIngestion
- Create
Namespace Error - Errors returned by CreateNamespace
- Create
Template Alias Error - Errors returned by CreateTemplateAlias
- Create
Template Error - Errors returned by CreateTemplate
- Create
Theme Alias Error - Errors returned by CreateThemeAlias
- Create
Theme Error - Errors returned by CreateTheme
- Delete
Account Customization Error - Errors returned by DeleteAccountCustomization
- Delete
Analysis Error - Errors returned by DeleteAnalysis
- Delete
Dashboard Error - Errors returned by DeleteDashboard
- Delete
Data SetError - Errors returned by DeleteDataSet
- Delete
Data Source Error - Errors returned by DeleteDataSource
- Delete
Folder Error - Errors returned by DeleteFolder
- Delete
Folder Membership Error - Errors returned by DeleteFolderMembership
- Delete
Group Error - Errors returned by DeleteGroup
- Delete
Group Membership Error - Errors returned by DeleteGroupMembership
- DeleteIAM
Policy Assignment Error - Errors returned by DeleteIAMPolicyAssignment
- Delete
Namespace Error - Errors returned by DeleteNamespace
- Delete
Template Alias Error - Errors returned by DeleteTemplateAlias
- Delete
Template Error - Errors returned by DeleteTemplate
- Delete
Theme Alias Error - Errors returned by DeleteThemeAlias
- Delete
Theme Error - Errors returned by DeleteTheme
- Delete
User ByPrincipal IdError - Errors returned by DeleteUserByPrincipalId
- Delete
User Error - Errors returned by DeleteUser
- Describe
Account Customization Error - Errors returned by DescribeAccountCustomization
- Describe
Account Settings Error - Errors returned by DescribeAccountSettings
- Describe
Analysis Error - Errors returned by DescribeAnalysis
- Describe
Analysis Permissions Error - Errors returned by DescribeAnalysisPermissions
- Describe
Dashboard Error - Errors returned by DescribeDashboard
- Describe
Dashboard Permissions Error - Errors returned by DescribeDashboardPermissions
- Describe
Data SetError - Errors returned by DescribeDataSet
- Describe
Data SetPermissions Error - Errors returned by DescribeDataSetPermissions
- Describe
Data Source Error - Errors returned by DescribeDataSource
- Describe
Data Source Permissions Error - Errors returned by DescribeDataSourcePermissions
- Describe
Folder Error - Errors returned by DescribeFolder
- Describe
Folder Permissions Error - Errors returned by DescribeFolderPermissions
- Describe
Folder Resolved Permissions Error - Errors returned by DescribeFolderResolvedPermissions
- Describe
Group Error - Errors returned by DescribeGroup
- DescribeIAM
Policy Assignment Error - Errors returned by DescribeIAMPolicyAssignment
- Describe
Ingestion Error - Errors returned by DescribeIngestion
- Describe
Namespace Error - Errors returned by DescribeNamespace
- Describe
Template Alias Error - Errors returned by DescribeTemplateAlias
- Describe
Template Error - Errors returned by DescribeTemplate
- Describe
Template Permissions Error - Errors returned by DescribeTemplatePermissions
- Describe
Theme Alias Error - Errors returned by DescribeThemeAlias
- Describe
Theme Error - Errors returned by DescribeTheme
- Describe
Theme Permissions Error - Errors returned by DescribeThemePermissions
- Describe
User Error - Errors returned by DescribeUser
- GetDashboard
Embed UrlError - Errors returned by GetDashboardEmbedUrl
- GetSession
Embed UrlError - Errors returned by GetSessionEmbedUrl
- List
Analyses Error - Errors returned by ListAnalyses
- List
Dashboard Versions Error - Errors returned by ListDashboardVersions
- List
Dashboards Error - Errors returned by ListDashboards
- List
Data Sets Error - Errors returned by ListDataSets
- List
Data Sources Error - Errors returned by ListDataSources
- List
Folder Members Error - Errors returned by ListFolderMembers
- List
Folders Error - Errors returned by ListFolders
- List
Group Memberships Error - Errors returned by ListGroupMemberships
- List
Groups Error - Errors returned by ListGroups
- ListIAM
Policy Assignments Error - Errors returned by ListIAMPolicyAssignments
- ListIAM
Policy Assignments ForUser Error - Errors returned by ListIAMPolicyAssignmentsForUser
- List
Ingestions Error - Errors returned by ListIngestions
- List
Namespaces Error - Errors returned by ListNamespaces
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Template Aliases Error - Errors returned by ListTemplateAliases
- List
Template Versions Error - Errors returned by ListTemplateVersions
- List
Templates Error - Errors returned by ListTemplates
- List
Theme Aliases Error - Errors returned by ListThemeAliases
- List
Theme Versions Error - Errors returned by ListThemeVersions
- List
Themes Error - Errors returned by ListThemes
- List
User Groups Error - Errors returned by ListUserGroups
- List
Users Error - Errors returned by ListUsers
- Register
User Error - Errors returned by RegisterUser
- Restore
Analysis Error - Errors returned by RestoreAnalysis
- Search
Analyses Error - Errors returned by SearchAnalyses
- Search
Dashboards Error - Errors returned by SearchDashboards
- Search
Folders Error - Errors returned by SearchFolders
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Account Customization Error - Errors returned by UpdateAccountCustomization
- Update
Account Settings Error - Errors returned by UpdateAccountSettings
- Update
Analysis Error - Errors returned by UpdateAnalysis
- Update
Analysis Permissions Error - Errors returned by UpdateAnalysisPermissions
- Update
Dashboard Error - Errors returned by UpdateDashboard
- Update
Dashboard Permissions Error - Errors returned by UpdateDashboardPermissions
- Update
Dashboard Published Version Error - Errors returned by UpdateDashboardPublishedVersion
- Update
Data SetError - Errors returned by UpdateDataSet
- Update
Data SetPermissions Error - Errors returned by UpdateDataSetPermissions
- Update
Data Source Error - Errors returned by UpdateDataSource
- Update
Data Source Permissions Error - Errors returned by UpdateDataSourcePermissions
- Update
Folder Error - Errors returned by UpdateFolder
- Update
Folder Permissions Error - Errors returned by UpdateFolderPermissions
- Update
Group Error - Errors returned by UpdateGroup
- UpdateIAM
Policy Assignment Error - Errors returned by UpdateIAMPolicyAssignment
- Update
Template Alias Error - Errors returned by UpdateTemplateAlias
- Update
Template Error - Errors returned by UpdateTemplate
- Update
Template Permissions Error - Errors returned by UpdateTemplatePermissions
- Update
Theme Alias Error - Errors returned by UpdateThemeAlias
- Update
Theme Error - Errors returned by UpdateTheme
- Update
Theme Permissions Error - Errors returned by UpdateThemePermissions
- Update
User Error - Errors returned by UpdateUser
Traits§
- Quicksight
- Trait representing the capabilities of the Amazon QuickSight API. Amazon QuickSight clients implement this trait.