AWS Amazon QuickSight CLI Commands

Creates new reviewed answers for a Q Topic.

Deletes reviewed answers for Q Topic.

Cancels an ongoing ingestion of data into SPICE.

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customi

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't ha

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.

Creates an Quick Sight brand.

Creates a custom permissions profile.

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight da

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Creates a data source.

Creates an empty shared folder.

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-ac

Adds an Amazon Quick Sight user to an Amazon Quick Sight group.

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, u

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours befo

(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace.

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Use CreateRoleMembership to add an existing Quick Sight group to an existing role.

Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis a

Creates a template alias for a template.

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.

Creates a theme alias for a theme.

Creates a new Q topic.

Creates a topic refresh schedule.

Creates a new VPC connection.

Unapplies a custom permissions profile from an account.

This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users wi

Deleting 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 Quic

Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the en

This API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Befo

Deletes a brand assignment.

Deletes a custom permissions profile.

Deletes a dashboard.

Deletes a dataset.

Deletes the dataset refresh properties of the dataset.

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

Deletes a linked Amazon Q Business application from an Quick Sight account

Deletes an empty folder.

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Removes a user group from Amazon Quick Sight.

Removes a user from a group so that the user is no longer a member of the group.

Deletes an existing IAM policy assignment.

Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

Deletes a refresh schedule from a dataset.

Removes custom permissions from the role.

Removes a group from a role.

Deletes a template.

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

Deletes a theme.

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

Deletes a topic.

Deletes a topic refresh schedule.

Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.

Deletes a user identified by its principal ID.

Deletes a custom permissions profile from a user.

Deletes a VPC connection.

Describes the custom permissions profile that is applied to an account.

Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you ru

Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.

Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.

Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.

Provides a summary of the metadata for an analysis.

Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

Provides the read and write permissions for an analysis.

Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJo

Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

Describes a brand.

Describes a brand assignment.

Describes the published version of the brand.

Describes a custom permissions profile.

Provides a summary for a dashboard.

Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Describes read and write permissions for a dashboard.

Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible erro

Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard S

Describes an existing dashboard QA configuration.

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Describes the refresh properties of a dataset.

Describes a data source.

Describes the resource permissions for a data source.

Describes a Amazon Q Business application that is linked to an Quick Sight account.

Describes a folder.

Describes permissions for a folder.

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Describes an existing IAM policy assignment, as specified by the assignment name.

Describes a SPICE ingestion.

Provides a summary and status of IP rules.

Describes all customer managed key registrations in a Quick Sight account.

Describes the current namespace.

Describes a personalization configuration.

Describes the state of a Quick Sight Q Search configuration.

Provides a summary of a refresh schedule.

Describes all custom permissions that are mapped to a role.

Describes the self-upgrade configuration for a Quick account.

Describes a template's metadata.

Describes the template alias for a template.

Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

Describes read and write permissions on a template.

Describes a theme.

Describes the alias for a theme.

Describes the read and write permissions for a theme.

Describes a topic.

Describes the permissions of a topic.

Describes the status of a topic refresh.

Deletes a topic refresh schedule.

Returns information about a user, given the user name.

Describes a VPC connection.

Generates 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. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It conta

Generates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions. The foll

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions

Generates 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. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashbo

Retrieves the metadata of a flow, not including its definition specifying the steps.

Get permissions for a flow.

Retrieves 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. Currently, you can call the following APIs with identity-enhanced Credentials StartDashboar

Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who acc

Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.

Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

Lists all brands in an Quick Sight account.

Returns a list of all the custom permissions profiles.

Lists all the versions of the dashboards in the Amazon Quick Sight subscription.

Lists dashboards in an Amazon Web Services account.

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

Lists flows in an Amazon Web Services account.

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

Lists all folders in an account.

List all folders that a resource is a member of.

Lists member users in a group.

Lists all user groups in Amazon Quick Sight.

Lists the IAM policy assignments in the current Amazon Quick Sight account.

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

Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.

Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

Lists all groups that are associated with a role.

Lists all self-upgrade requests for a Quick account.

Lists the tags assigned to a resource.

Lists all the aliases of a template.

Lists all the versions of the templates in the current Amazon Quick Sight account.

Lists all the templates in the current Amazon Quick Sight account.

Lists all the aliases of a theme.

Lists all the versions of the themes in the current Amazon Web Services account.

Lists all the themes in the current Amazon Web Services account.

Lists all of the refresh schedules for a topic.

Lists all reviewed answers for a Q Topic.

Lists all of the topics within an account.

Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.

Returns a list of all of the Amazon Quick Sight users belonging to this account.

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

Predicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have

Creates or updates the dataset refresh properties for the dataset.

Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create

Restores an analysis.

Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.

Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Use the SearchDataSets operation to search for datasets that belong to an account.

Use the SearchDataSources operation to search for data sources that belong to an account.

Search for the flows in an Amazon Web Services account.

Searches the subfolders in a folder.

Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.

Searches for any Q topic that exists in an Quick account.

Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully c

Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are use

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight

Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use t

Removes a tag or tags from a resource.

Applies a custom permissions profile to an account.

Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizati

Updates the Amazon Quick Sight settings in your Amazon Web Services account.

Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/usergui

Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.

Updates an analysis in Amazon Quick Sight

Updates the read and write permissions for an analysis.

Updates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.

Updates a brand.

Updates a brand assignment.

Updates the published version of a brand.

Updates a custom permissions profile.

Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Updates the linked analyses on a dashboard.

Updates read and write permissions on a dashboard.

Updates the published version of a dashboard.

Updates a Dashboard QA configuration.

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Updates a data source.

Updates the permissions to a data source.

Updates a Amazon Q Business application that is linked to a Quick Sight account.

Updates permissions against principals on a flow.

Updates the name of a folder.

Updates permissions of a folder.

Changes a group description.

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity Center

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation

Updates a customer managed key in a Quick Sight account.

This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensur

Updates a personalization configuration.

Updates the state of a Quick Sight Q Search configuration.

Updates a refresh schedule for a dataset.

Updates the custom permissions that are associated with a role.

Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.

Updates the self-upgrade configuration for a Quick account.

Updates the SPICE capacity configuration for a Quick Sight account.

Updates a template from an existing Amazon Quick Sight analysis or another template.

Updates the template alias of a template.

Updates the resource permissions for a template.

Updates a theme.

Updates an alias of a theme.

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permi

Updates a topic.

Updates the permissions of a topic.

Updates a topic refresh schedule.

Updates an Amazon Quick Sight user.

Updates a custom permissions profile for a user.

Updates a VPC connection.