aws quicksight
Amazon Quick Sight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. AWS CLI reference
301 commands Its page in the AWS CLI reference
Commands
batch-create-topic-reviewed-answerCreates new reviewed answers for a Q Topic.batch-delete-knowledge-baseDeletes one or more knowledge bases.batch-delete-topic-reviewed-answerDeletes reviewed answers for Q Topic.batch-describe-user-limitsDescribes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.cancel-ingestionCancels an ongoing ingestion of data into SPICE.create-account-customizationCreates Amazon Quick Sight customizations.create-account-subscriptionCreates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.create-action-connectorCreates an action connector that enables Amazon Quick Sight to connect to external services and perform actions.create-agentCreates an agent in Amazon QuickSight.create-analysisCreates an analysis in Amazon Quick Sight.create-approval-policyCreates an approval policy in Quick Sight.create-brandCreates an Quick Sight brand.create-custom-permissionsCreates a custom permissions profile.create-dashboardCreates a dashboard from either a template or directly with a DashboardDefinition.create-data-setCreates a dataset.create-data-sourceCreates a data source.create-dlp-settingCreates a data loss prevention (DLP) setting configuration for an Amazon Web Services account.create-flowCreates a new flow in the specified Amazon Web Services account.create-folderCreates an empty shared folder.create-folder-membershipAdds an asset, such as a dashboard, analysis, or dataset into a folder.create-groupUse the CreateGroup operation to create a group in Quick Sight.create-group-membershipAdds an Amazon Quick Sight user to an Amazon Quick Sight group.create-iam-policy-assignmentCreates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).create-ingestionCreates and starts a new SPICE ingestion for a dataset.create-knowledge-baseCreates a knowledge base from a specified data source.create-limits-profileCreates a limits profile that defines resource usage limits for Amazon Quick Sight users.create-namespace(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.create-o-auth-client-applicationCreates an OAuthClientApplication.create-refresh-scheduleCreates a refresh schedule for a dataset.create-role-membershipUse CreateRoleMembership to add an existing Quick Sight group to an existing role.create-spaceCreates a new Amazon QuickSight space.create-templateCreates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template.create-template-aliasCreates a template alias for a template.create-themeCreates a theme.create-theme-aliasCreates a theme alias for a theme.create-topicCreates a new Q topic.create-topic-refresh-scheduleCreates a topic refresh schedule.create-topic-v2Creates a new Q topic.create-vpc-connectionCreates a new VPC connection.delete-account-custom-permissionUnapplies a custom permissions profile from an account.delete-account-customizationThis API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace.delete-account-subscriptionDeleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.delete-action-connectorHard deletes an action connector, making it unrecoverable.delete-agentDeletes an agent.delete-analysisDeletes an analysis from Amazon Quick Sight.delete-appDeletes an app.delete-approval-policyDeletes an approval policy in Quick Sight.delete-brandThis API permanently deletes the specified Quick Sight brand.delete-brand-assignmentDeletes a brand assignment.delete-custom-permissionsDeletes a custom permissions profile.delete-dashboardDeletes a dashboard.delete-data-setDeletes a dataset.delete-data-set-refresh-propertiesDeletes the dataset refresh properties of the dataset.delete-data-sourceDeletes the data source permanently.delete-default-q-business-applicationDeletes a linked Amazon Q Business application from an Quick Sight accountdelete-dlp-settingDeletes a DLP setting configuration from an Amazon Web Services account.delete-flowPermanently deletes a flow from the specified Amazon Web Services account.delete-folderDeletes an empty folder.delete-folder-membershipRemoves an asset, such as a dashboard, analysis, or dataset, from a folder.delete-groupRemoves a user group from Amazon Quick Sight.delete-group-membershipRemoves a user from a group so that the user is no longer a member of the group.delete-iam-policy-assignmentDeletes an existing IAM policy assignment.delete-identity-propagation-configDeletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.delete-knowledge-baseDeletes a knowledge base.delete-limits-profileDeletes a limits profile.delete-namespaceDeletes a namespace and the users and groups that are associated with the namespace.delete-o-auth-client-applicationDeletes an OAuthClientApplication.delete-refresh-scheduleDeletes a refresh schedule from a dataset.delete-role-custom-permissionRemoves custom permissions from the role.delete-role-membershipRemoves a group from a role.delete-spaceDeletes an Amazon QuickSight space.delete-templateDeletes a template.delete-template-aliasDeletes the item that the specified template alias points to.delete-themeDeletes a theme.delete-theme-aliasDeletes the version of the theme that the specified theme alias points to.delete-topicDeletes a topic.delete-topic-refresh-scheduleDeletes a topic refresh schedule.delete-topic-v2Deletes a Q topic.delete-userDeletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call.delete-user-by-principal-idDeletes a user identified by its principal ID.delete-user-custom-permissionDeletes a custom permissions profile from a user.delete-vpc-connectionDeletes a VPC connection.describe-account-custom-permissionDescribes the custom permissions profile that is applied to an account.describe-account-customizationDescribes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace.describe-account-settingsDescribes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.describe-account-subscriptionUse the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription.describe-action-connectorRetrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.describe-action-connector-permissionsRetrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.describe-agentDescribes an agent.describe-agent-permissionsDescribes the resource permissions for an agent.describe-analysisProvides a summary of the metadata for an analysis.describe-analysis-definitionProvides a detailed description of the definition of an analysis.describe-analysis-permissionsProvides the read and write permissions for an analysis.describe-appDescribes an app.describe-app-permissionsDescribes the resource permissions for an app.describe-approval-policyDescribes an approval policy in Quick Sight.describe-asset-bundle-export-jobDescribes an existing export job.describe-asset-bundle-import-jobDescribes an existing import job.describe-automation-jobRetrieves the status and details of a specified automation job, including its status and outputs.describe-brandDescribes a brand.describe-brand-assignmentDescribes a brand assignment.describe-brand-published-versionDescribes the published version of the brand.describe-custom-permissionsDescribes a custom permissions profile.describe-dashboardProvides a summary for a dashboard.describe-dashboard-definitionProvides a detailed description of the definition of a dashboard.describe-dashboard-permissionsDescribes read and write permissions for a dashboard.describe-dashboard-snapshot-jobDescribes an existing snapshot job.describe-dashboard-snapshot-job-resultDescribes the result of an existing snapshot job that has finished running.describe-dashboards-qa-configurationDescribes an existing dashboard QA configuration.describe-data-setDescribes a dataset.describe-data-set-permissionsDescribes the permissions on a dataset.describe-data-set-refresh-propertiesDescribes the refresh properties of a dataset.describe-data-sourceDescribes a data source.describe-data-source-permissionsDescribes the resource permissions for a data source.describe-default-q-business-applicationDescribes a Amazon Q Business application that is linked to an Quick Sight account.describe-dlp-settingDescribes the full configuration of a DLP setting in an Amazon Web Services account.describe-flowReturns the full details of a flow for the latest version of the requested publish state.describe-folderDescribes a folder.describe-folder-permissionsDescribes permissions for a folder.describe-folder-resolved-permissionsDescribes the folder resolved permissions.describe-groupReturns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).describe-group-membershipUse the DescribeGroupMembership operation to determine if a user is a member of the specified group.describe-iam-policy-assignmentDescribes an existing IAM policy assignment, as specified by the assignment name.describe-ingestionDescribes a SPICE ingestion.describe-ip-restrictionProvides a summary and status of IP rules.describe-key-registrationDescribes all customer managed key registrations in a Quick Sight account.describe-knowledge-baseDescribes a knowledge base.describe-knowledge-base-permissionsDescribes the resource permissions for a knowledge base.describe-limits-profileDescribes the properties of an existing limits profile.describe-namespaceDescribes the current namespace.describe-o-auth-client-applicationDescribes an OAuthClientApplication.describe-q-personalization-configurationDescribes a personalization configuration.describe-quick-sight-q-search-configurationDescribes the state of a Quick Sight Q Search configuration.describe-refresh-scheduleProvides a summary of a refresh schedule.describe-resource-permissionsDescribes the service role configuration for your Amazon Quick Sight account.describe-role-custom-permissionDescribes all custom permissions that are mapped to a role.describe-self-upgrade-configurationDescribes the self-upgrade configuration for a Quick account.describe-spaceDescribes an Amazon QuickSight space.describe-space-permissionsDescribes the permissions for an Amazon QuickSight space.describe-templateDescribes a template's metadata.describe-template-aliasDescribes the template alias for a template.describe-template-definitionProvides a detailed description of the definition of a template.describe-template-permissionsDescribes read and write permissions on a template.describe-themeDescribes a theme.describe-theme-aliasDescribes the alias for a theme.describe-theme-permissionsDescribes the read and write permissions for a theme.describe-topicDescribes a topic.describe-topic-permissionsDescribes the permissions of a topic.describe-topic-permissions-v2Describes the permissions of a topic.describe-topic-refreshDescribes the status of a topic refresh.describe-topic-refresh-scheduleDeletes a topic refresh schedule.describe-topic-v2Describes a Q topic.describe-userReturns information about a user, given the user name.describe-vpc-connectionDescribes a VPC connection.generate-embed-url-for-anonymous-userGenerates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users.generate-embed-url-for-registered-userGenerates an embed URL that you can use to embed an Amazon Quick experience in your website.generate-embed-url-for-registered-user-with-identityGenerates an embed URL that you can use to embed an Amazon Quick Sight experience in your website.get-dashboard-embed-urlGenerates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application.get-flow-metadataRetrieves the metadata of a flow, not including its definition specifying the steps.get-flow-permissionsGet permissions for a flow.get-identity-contextRetrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.get-session-embed-urlGenerates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code.list-action-connectorsLists all action connectors in the specified Amazon Web Services account.list-agentsLists all agents in an Amazon QuickSight account.list-analysesLists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.list-approval-policiesLists all approval policies in the specified Quick Sight account.list-appsLists the apps in an Amazon Web Services account.list-asset-bundle-export-jobsLists all asset bundle export jobs that have been taken place in the last 14 days.list-asset-bundle-import-jobsLists all asset bundle import jobs that have taken place in the last 14 days.list-brandsLists all brands in an Quick Sight account.list-custom-permissionsReturns a list of all the custom permissions profiles.list-dashboard-versionsLists all the versions of the dashboards in the Amazon Quick Sight subscription.list-dashboardsLists dashboards in an Amazon Web Services account.list-data-setsLists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.list-data-sourcesLists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.list-dlp-settingsLists all DLP settings in an Amazon Web Services account.list-flowsLists flows in an Amazon Web Services account.list-folder-membersList all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.list-foldersLists all folders in an account.list-folders-for-resourceList all folders that a resource is a member of.list-group-membershipsLists member users in a group.list-groupsLists all user groups in Amazon Quick Sight.list-iam-policy-assignmentsLists the IAM policy assignments in the current Amazon Quick Sight account.list-iam-policy-assignments-for-userLists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.list-identity-propagation-configsLists all services and authorized targets that the Quick Sight IAM Identity Center application can access.list-ingestionsLists the history of SPICE ingestions for a dataset.list-knowledge-basesLists all knowledge bases in an Amazon QuickSight account.list-limits-profilesLists all limits profiles in an Amazon Quick Sight account.list-namespacesLists the namespaces for the specified Amazon Web Services account.list-o-auth-client-applicationsLists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.list-refresh-schedulesLists the refresh schedules of a dataset.list-role-membershipsLists all groups that are associated with a role.list-self-upgradesLists all self-upgrade requests for a Quick account.list-space-resourcesLists the resources in an Amazon QuickSight space.list-spacesLists all Amazon QuickSight spaces in an Amazon Web Services account.list-tags-for-resourceLists the tags assigned to a resource.list-template-aliasesLists all the aliases of a template.list-template-versionsLists all the versions of the templates in the current Amazon Quick Sight account.list-templatesLists all the templates in the current Amazon Quick Sight account.list-theme-aliasesLists all the aliases of a theme.list-theme-versionsLists all the versions of the themes in the current Amazon Web Services account.list-themesLists all the themes in the current Amazon Web Services account.list-topic-refresh-schedulesLists all of the refresh schedules for a topic.list-topic-reviewed-answersLists all reviewed answers for a Q Topic.list-topicsLists all of the topics within an account.list-topics-v2Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.list-user-groupsLists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.list-usersReturns a list of all of the Amazon Quick Sight users belonging to this account.list-users-index-capacityLists per-user index capacity consumption for an account.list-vpc-connectionsLists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.predict-qa-resultsPredicts existing visuals or generates new visuals to answer a given query.put-data-set-refresh-propertiesCreates or updates the dataset refresh properties for the dataset.register-userCreates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.restore-analysisRestores an analysis.search-action-connectorsSearches for action connectors in the specified Amazon Web Services account using filters.search-agentsSearches for agents based on specified filters.search-analysesSearches for analyses that belong to the user specified in the filter.search-appsSearches for apps in an Amazon Web Services account using the specified filters.search-dashboardsSearches for dashboards that belong to a user.search-data-setsUse the SearchDataSets operation to search for datasets that belong to an account.search-data-sourcesUse the SearchDataSources operation to search for data sources that belong to an account.search-flowsSearch for the flows in an Amazon Web Services account.search-foldersSearches the subfolders in a folder.search-groupsUse the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.search-knowledge-basesSearches for a subset of knowledge bases based on specified filters.search-spacesSearches for Amazon QuickSight spaces that match the specified filters.search-topicsSearches for any Q topic that exists in an Quick account.search-topics-v2Searches for any Q topic that exists in an Amazon Web Services account.start-asset-bundle-export-jobStarts an Asset Bundle export job.start-asset-bundle-import-jobStarts an Asset Bundle import job.start-automation-jobStarts a new job for a specified automation.start-dashboard-snapshot-jobStarts an asynchronous job that generates a snapshot of a dashboard's output.start-dashboard-snapshot-job-scheduleStarts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.tag-resourceAssigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.untag-resourceRemoves a tag or tags from a resource.update-account-custom-permissionApplies a custom permissions profile to an account.update-account-customizationUpdates Amazon Quick Sight customizations.update-account-settingsUpdates the Amazon Quick Sight settings in your Amazon Web Services account.update-action-connectorUpdates an existing action connector with new configuration details, authentication settings, or enabled actions.update-action-connector-permissionsUpdates the permissions for an action connector by granting or revoking access for specific users and groups.update-agentUpdates an existing agent.update-agent-permissionsUpdates the resource permissions for an agent.update-analysisUpdates an analysis in Amazon Quick Sightupdate-analysis-permissionsUpdates the read and write permissions for an analysis.update-app-permissionsUpdates the resource permissions for an app.update-application-with-token-exchange-grantUpdates an Quick application with a token exchange grant.update-approval-policyUpdates an approval policy in Quick Sight.update-brandUpdates a brand.update-brand-assignmentUpdates a brand assignment.update-brand-published-versionUpdates the published version of a brand.update-custom-permissionsUpdates a custom permissions profile.update-dashboardUpdates a dashboard in an Amazon Web Services account.update-dashboard-linksUpdates the linked analyses on a dashboard.update-dashboard-permissionsUpdates read and write permissions on a dashboard.update-dashboard-published-versionUpdates the published version of a dashboard.update-dashboards-qa-configurationUpdates a Dashboard QA configuration.update-data-setUpdates a dataset.update-data-set-permissionsUpdates the permissions on a dataset.update-data-sourceUpdates a data source.update-data-source-permissionsUpdates the permissions to a data source.update-default-q-business-applicationUpdates a Amazon Q Business application that is linked to a Quick Sight account.update-dlp-settingUpdates an existing DLP setting configuration in an Amazon Web Services account.update-flowUpdates an existing flow.update-flow-permissionsUpdates permissions against principals on a flow.update-folderUpdates the name of a folder.update-folder-permissionsUpdates permissions of a folder.update-groupChanges a group description.update-iam-policy-assignmentUpdates an existing IAM policy assignment.update-identity-propagation-configAdds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.update-ip-restrictionUpdates the content and status of IP rules.update-key-registrationUpdates a customer managed key in a Quick Sight account.update-knowledge-baseUpdates the properties of an existing knowledge base.update-knowledge-base-permissionsUpdates the resource permissions for a knowledge base.update-limits-profileUpdates the properties of an existing limits profile.update-o-auth-client-applicationUpdates an OAuthClientApplication.update-public-sharing-settingsThis API controls public sharing settings for your entire Quick Sight account, affecting data security and access.update-q-personalization-configurationUpdates a personalization configuration.update-quick-sight-q-search-configurationUpdates the state of a Quick Sight Q Search configuration.update-refresh-scheduleUpdates a refresh schedule for a dataset.update-resource-permissionsUpdates the service role configuration that Amazon Quick Sight uses to access resources in your Amazon Web Services account.update-role-custom-permissionUpdates the custom permissions that are associated with a role.update-self-upgradeUpdates a self-upgrade request for a Quick user by approving, denying, or verifying the request.update-self-upgrade-configurationUpdates the self-upgrade configuration for a Quick account.update-spaceUpdates the metadata of an Amazon QuickSight space.update-space-permissionsUpdates the permissions for an Amazon QuickSight space.update-space-resourcesAdds or removes resources from an Amazon QuickSight space.update-spice-capacity-configurationUpdates the SPICE capacity configuration for a Quick Sight account.update-templateUpdates a template from an existing Amazon Quick Sight analysis or another template.update-template-aliasUpdates the template alias of a template.update-template-permissionsUpdates the resource permissions for a template.update-themeUpdates a theme.update-theme-aliasUpdates an alias of a theme.update-theme-permissionsUpdates the resource permissions for a theme.update-topicUpdates a topic.update-topic-permissionsUpdates the permissions of a topic.update-topic-permissions-v2Updates the permissions of a topic.update-topic-refresh-scheduleUpdates a topic refresh schedule.update-topic-v2Updates the definition of a Q topic.update-userUpdates an Amazon Quick Sight user.update-user-custom-permissionUpdates a custom permissions profile for a user.update-vpc-connectionUpdates a VPC connection.