Data retrieval APIs for Amazon QuickSight
Amazon QuickSight provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchGetPreferences | Get user preferences | Read |
| DescribeAccountCustomPermission | Describe the custom permission associated with an account | Read |
| DescribeAccountCustomization | Describe an account customization for QuickSight account or namespace | Read |
| DescribeAccountSettings | Describe the administrative account settings for QuickSight account | Read |
| DescribeAccountSubscription | Describe a QuickSight account | Read |
| DescribeActionConnector | Describe an action connector | Read |
| DescribeActionConnectorPermissions | Describe permissions for an action connector | Read |
| DescribeAgent | Describe an agent | Read |
| DescribeAgentPermissions | Describe agent's permissions | Read |
| DescribeAnalysis | Describe an analysis | Read |
| DescribeAnalysisPermissions | Describe permissions for an analysis | Read |
| DescribeAssetBundleExportJob | Describe an asset bundle export job | Read |
| DescribeAssetBundleImportJob | Describe an asset bundle import job | Read |
| DescribeAutomationJob | Describe an automation job | Read |
| DescribeBrand | Describe a brand | Read |
| DescribeBrandAssignment | Describe a brand assignment | Read |
| DescribeBrandPublishedVersion | Describes the published version of the brand | Read |
| DescribeChatConfiguration | Describe chat configuration | Read |
| DescribeCustomPermissions | Describe a custom permissions resource in a QuickSight account | Read |
| DescribeDashboard | Describe a QuickSight Dashboard | Read |
| DescribeDashboardPermissions | Describe permissions for a QuickSight Dashboard | Read |
| DescribeDashboardSnapshotJob | Describe a dashboard snapshot job | Read |
| DescribeDashboardSnapshotJobResult | Describe result of a dashboard snapshot job | Read |
| DescribeDashboardsQAConfiguration | Describe dashboards qa configuration | Read |
| DescribeDataSet | Describe a dataset | Read |
| DescribeDataSetRefreshProperties | Describe refresh properties for a dataset | Read |
| DescribeDataSource | Describe a data source | Read |
| DescribeDefaultQBusinessApplication | Describe linked QBusiness application Id for QuickSight account | Read |
| DescribeEmailCustomizationTemplate | Describe a QuickSight email customization template | Read |
| DescribeExtensionAccess | Describe an extension access | Read |
| DescribeFolder | Describe a QuickSight Folder | Read |
| DescribeFolderPermissions | Describe permissions for a QuickSight Folder | Read |
| DescribeFolderResolvedPermissions | Describe resolved permissions for a QuickSight Folder | Read |
| DescribeGroup | Describe a QuickSight group | Read |
| DescribeGroupMembership | Describe a QuickSight group member | Read |
| DescribeIAMPolicyAssignment | Describe an existing assignment | Read |
| DescribeIngestion | Describe a SPICE ingestion on a dataset | Read |
| DescribeIpRestriction | Describe the IP restrictions for QuickSight account | Read |
| DescribeKeyRegistration | Describe QuickSight key registration | Read |
| DescribeNamespace | Describe a QuickSight namespace | Read |
| DescribeQPersonalizationConfiguration | Describe a personalization configuration | Read |
| DescribeQuickIndexCapacity | Describe index capacity | Read |
| DescribeQuickSightQSearchConfiguration | Describe QuickSight Q Search configuration | Read |
| DescribeRefreshSchedule | Describe a refresh schedule for a dataset | Read |
| DescribeRoleCustomPermission | Describe the custom permission associated with a role | Read |
| DescribeSelfUpgradeConfiguration | Describe the administrative self upgrade configuration associated with an account | Read |
| DescribeTemplate | Describe a template | Read |
| DescribeTemplateAlias | Describe a template alias | Read |
| DescribeTemplatePermissions | Describe permissions for a template | Read |
| DescribeTheme | Describe a theme | Read |
| DescribeThemeAlias | Describe a theme alias | Read |
| DescribeThemePermissions | Describe permissions for a theme | Read |
| DescribeTopic | Describe a topic | Read |
| DescribeTopicRefresh | Describe the refresh status of a topic | Read |
| DescribeTopicRefreshSchedule | Describe a refresh schedule for a topic | Read |
| DescribeUser | Describe a QuickSight user given the user name | Read |
| DescribeVPCConnection | Describe a vpc connection | Read |
| GetAnonymousUserEmbedUrl | Get a URL used to embed a QuickSight Dashboard for a user not registered with QuickSight | Read |
| GetAuthCode | Get an auth code representing a QuickSight user | Read |
| GetCustomPermissionsSummary | Get information about the custom permissions in an account | Read |
| GetDashboardEmbedUrl | Get a URL used to embed a QuickSight Dashboard | Read |
| GetFlowMetadata | Get metadata for a flow | Read |
| GetFlowPermissions | Get permissions for a flow | Read |
| GetGroupMapping | Use Amazon QuickSight, in Enterprise edition, to identify and display the Microsoft Active Directory (Microsoft Active Directory) directory groups that are mapped to roles in Amazon QuickSight | Read |
| GetIdentityContext | Get identity context for a user | Read |
| GetSessionEmbedUrl | Get a URL to embed QuickSight console experience | Read |
| ListActionConnectors | List action connectors | List |
| ListAgents | List agents | List |
| ListAnalyses | List all analyses in an account | List |
| ListAssetBundleExportJobs | List all asset bundle export jobs | List |
| ListAssetBundleImportJobs | List all asset bundle import jobs | List |
| ListBrands | Lists all brands in an Amazon QuickSight account | List |
| ListCustomPermissions | List custom permissions resources in QuickSight account | List |
| ListCustomerManagedKeys | List all registered customer managed keys | List |
| ListDashboardVersions | List all versions of a QuickSight Dashboard | List |
| ListDashboards | List all Dashboards in a QuickSight Account | List |
| ListDataSets | List all datasets | List |
| ListDataSources | List all data sources | List |
| ListExtensionAccesses | List extension accesses | List |
| ListFlows | List all flows in an Amazon QuickSight account | List |
| ListFolderMembers | List all members in a folder | Read |
| ListFolders | List all Folders in a QuickSight Account | List |
| ListFoldersForResource | List all Folders in which a QuickSight resource is a member | List |
| ListGroupMemberships | List member users in a group | List |
| ListGroups | List all user groups in QuickSight | List |
| ListIAMPolicyAssignments | List all assignments in the current Amazon QuickSight account | List |
| ListIAMPolicyAssignmentsForUser | List all assignments assigned to a user and the groups it belongs | List |
| ListIdentityPropagationConfigs | List AWS services enabled for trusted identity propagation in QuickSight | List |
| ListIngestions | List all SPICE ingestions on a dataset | List |
| ListKMSKeysForUser | List a user's KMS keys | List |
| ListNamespaces | Lists all namespaces in a QuickSight account | List |
| ListRefreshSchedules | List all refresh schedules on a dataset | List |
| ListRoleMemberships | List the members of a role | List |
| ListSelfUpgrades | List all of the pending self upgrade requests associated with an account | List |
| ListTagsForResource | List tags of a QuickSight resource | Read |
| ListTemplateAliases | List all aliases for a template | List |
| ListTemplateVersions | List all versions of a template | List |
| ListTemplates | List all templates in a QuickSight account | List |
| ListThemeAliases | List all aliases of a theme | List |
| ListThemeVersions | List all versions of a theme | List |
| ListThemes | List all themes in an account | List |
| ListTopicRefreshSchedules | List all refresh schedules on a topic | List |
| ListTopicReviewedAnswers | List all reviewed answers for topic | List |
| ListTopics | List all topics | List |
| ListUserGroups | List groups that a given user is a member of | List |
| ListUsers | List all of the QuickSight users belonging to this account | List |
| ListVPCConnections | List all vpc connections | List |
| PassDataSet | Use a dataset for a template | Read |
| PassDataSource | Use a data source for a data set | Read |
| PredictQAResults | Predict QA results | Read |
| QuickSuiteUsageMetrics | Get QuickSuite usage metrics | Read |
| SearchActionConnectors | Search action connectors | List |
| SearchAgents | Search agents | List |
| SearchAnalyses | Search for a sub-set of analyses | List |
| SearchDashboards | Search for a sub-set of QuickSight Dashboards | List |
| SearchDataSets | Search for a sub-set of QuickSight DatSets | List |
| SearchDataSources | Search for a sub-set of QuickSight Data Sources | List |
| SearchDirectoryGroups | Use Amazon QuickSight, in Enterprise edition, to display your Microsoft Active Directory directory groups so that you can choose which ones to map to roles in Amazon QuickSight | List |
| SearchFlows | Search flows in an Amazon QuickSight account | List |
| SearchFolders | Search for a sub-set of QuickSight Folders | Read |
| SearchGroups | Search for a sub-set of QuickSight groups | List |
| SearchTopics | Search for a sub-set of topics | List |
| SearchUsers | Search the QuickSight users belonging to this account | List |
