integrations.sh
← all integrations

amazonaws.com – quicksight

OpenAPI apis-guru cloud

Amazon QuickSight API Reference

Amazon QuickSight 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. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:quicksight/2018-04-01.json
Provider
amazonaws.com:quicksight / quicksight
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/quicksight/2018-04-01/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/quicksight/2018-04-01/openapi.yaml

Tools (136)

Extracted live via the executor SDK.

  • account.createAccountSubscription

    Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

    The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.

    Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see in the Amazon QuickSight User Guide.

    If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails.

    You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see in the Amazon QuickSight User Guide.

    You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see in the Amazon QuickSight User Guide.

  • account.deleteAccountSubscription

    Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

  • account.describeAccountSubscription

    Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight 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.

  • accounts.cancelIngestion

    Cancels an ongoing ingestion of data into SPICE.

  • accounts.createAccountCustomization

    Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see in the Amazon QuickSight User Guide.

    You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

    Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the API operation. To share the theme, grant permissions by using the API operation.

  • accounts.createAnalysis

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

  • accounts.createDashboard

    Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the API operation.

    A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

  • accounts.createDataSet

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

  • accounts.createDataSource

    Creates a data source.

  • accounts.createFolder

    Creates an empty shared folder.

  • accounts.createFolderMembership

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

  • accounts.createGroup

    Use the CreateGroup operation to create a group in Amazon QuickSight. 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 AWS Support.

    The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .

    The response is a group object.

  • accounts.createGroupMembership

    Adds an Amazon QuickSight user to an Amazon QuickSight group.

  • accounts.createIamPolicyAssignment

    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 QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

  • accounts.createIngestion

    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 before the current date and time.

    Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

  • accounts.createNamespace

    (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

    A namespace allows you to isolate the Amazon QuickSight 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. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

  • accounts.createRefreshSchedule

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

  • accounts.createTemplate

    Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

    A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the 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.

  • accounts.createTemplateAlias

    Creates a template alias for a template.

  • accounts.createTheme

    Creates a theme.

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

  • accounts.createThemeAlias

    Creates a theme alias for a theme.

  • accounts.deleteAccountCustomization

    Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

  • accounts.deleteAnalysis

    Deletes an analysis from Amazon QuickSight. 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 QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.

    At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

    An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

  • accounts.deleteDashboard

    Deletes a dashboard.

  • accounts.deleteDataSet

    Deletes a dataset.

  • accounts.deleteDataSetRefreshProperties

    Deletes the dataset refresh properties of the dataset.

  • accounts.deleteDataSource

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

  • accounts.deleteFolder

    Deletes an empty folder.

  • accounts.deleteFolderMembership

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

  • accounts.deleteGroup

    Removes a user group from Amazon QuickSight.

  • accounts.deleteGroupMembership

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

  • accounts.deleteIamPolicyAssignment

    Deletes an existing IAM policy assignment.

  • accounts.deleteNamespace

    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.

  • accounts.deleteRefreshSchedule

    Deletes a refresh schedule from a dataset.

  • accounts.deleteTemplate

    Deletes a template.

  • accounts.deleteTemplateAlias

    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.

  • accounts.deleteTheme

    Deletes a theme.

  • accounts.deleteThemeAlias

    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.

  • accounts.deleteUser

    Deletes the Amazon QuickSight 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.

  • accounts.deleteUserByPrincipalId

    Deletes a user identified by its principal ID.

  • accounts.describeAccountCustomization

    Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

    To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

    • Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

    • Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.

      To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:

      • Use .

      • Use .

      • Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see .

    • Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

    • Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

  • accounts.describeAccountSettings

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

  • accounts.describeAnalysis

    Provides a summary of the metadata for an analysis.

  • accounts.describeAnalysisDefinition

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

  • accounts.describeAnalysisPermissions

    Provides the read and write permissions for an analysis.

  • accounts.describeDashboard

    Provides a summary for a dashboard.

  • accounts.describeDashboardDefinition

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

  • accounts.describeDashboardPermissions

    Describes read and write permissions for a dashboard.

  • accounts.describeDataSet

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

  • accounts.describeDataSetPermissions

    Describes the permissions on a dataset.

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

  • accounts.describeDataSetRefreshProperties

    Describes the refresh properties of a dataset.

  • accounts.describeDataSource

    Describes a data source.

  • accounts.describeDataSourcePermissions

    Describes the resource permissions for a data source.

  • accounts.describeFolder

    Describes a folder.

  • accounts.describeFolderPermissions

    Describes permissions for a folder.

  • accounts.describeFolderResolvedPermissions

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

  • accounts.describeGroup

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

  • accounts.describeGroupMembership

    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.

  • accounts.describeIamPolicyAssignment

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

  • accounts.describeIngestion

    Describes a SPICE ingestion.

  • accounts.describeIpRestriction

    Provides a summary and status of IP rules.

  • accounts.describeNamespace

    Describes the current namespace.

  • accounts.describeRefreshSchedule

    Provides a summary of a refresh schedule.

  • accounts.describeTemplate

    Describes a template's metadata.

  • accounts.describeTemplateAlias

    Describes the template alias for a template.

  • accounts.describeTemplateDefinition

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

  • accounts.describeTemplatePermissions

    Describes read and write permissions on a template.

  • accounts.describeTheme

    Describes a theme.

  • accounts.describeThemeAlias

    Describes the alias for a theme.

  • accounts.describeThemePermissions

    Describes the read and write permissions for a theme.

  • accounts.describeUser

    Returns information about a user, given the user name.

  • accounts.generateEmbedUrlForAnonymousUser

    Generates an embed URL that you can use to embed an Amazon QuickSight 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 contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

    • The URL validity period should not be confused with the actual session lifetime that can be customized using the parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

    • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    For more information, see in the Amazon QuickSight User Guide.

    For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the .

  • accounts.generateEmbedUrlForRegisteredUser

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

    The following rules apply to the generated URL:

    • It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

    • The URL validity period should not be confused with the actual session lifetime that can be customized using the parameter.

      The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

    • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    For more information, see in the Amazon QuickSight User Guide.

    For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the .

  • accounts.getDashboardEmbedUrl

    Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight 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 GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

    • They must be used together.

    • They can be used one time only.

    • They are valid for 5 minutes after you run this command.

    • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

    • The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

    For more information, see in the Amazon QuickSight User Guide.

    For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the .

  • accounts.getSessionEmbedUrl

    Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight 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 access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the API operation. Use API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

  • accounts.listAnalyses

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

  • accounts.listDashboards

    Lists dashboards in an Amazon Web Services account.

  • accounts.listDashboardVersions

    Lists all the versions of the dashboards in the Amazon QuickSight subscription.

  • accounts.listDataSets

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

    *
  • accounts.listDataSources

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

  • accounts.listFolderMembers

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

  • accounts.listFolders

    Lists all folders in an account.

  • accounts.listGroupMemberships

    Lists member users in a group.

  • accounts.listGroups

    Lists all user groups in Amazon QuickSight.

  • accounts.listIamPolicyAssignments

    Lists IAM policy assignments in the current Amazon QuickSight account.

  • accounts.listIamPolicyAssignmentsForUser

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

  • accounts.listIngestions

    Lists the history of SPICE ingestions for a dataset.

  • accounts.listNamespaces

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

  • accounts.listRefreshSchedules

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

  • accounts.listTemplateAliases

    Lists all the aliases of a template.

  • accounts.listTemplates

    Lists all the templates in the current Amazon QuickSight account.

  • accounts.listTemplateVersions

    Lists all the versions of the templates in the current Amazon QuickSight account.

  • accounts.listThemeAliases

    Lists all the aliases of a theme.

  • accounts.listThemes

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

  • accounts.listThemeVersions

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

  • accounts.listUserGroups

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

  • accounts.listUsers

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

  • accounts.putDataSetRefreshProperties

    Creates or updates the dataset refresh properties for the dataset.

  • accounts.registerUser

    Creates an Amazon QuickSight 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 Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see .

  • accounts.restoreAnalysis

    Restores an analysis.

  • accounts.searchAnalyses

    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.

  • accounts.searchDashboards

    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.

  • accounts.searchDataSets

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

  • accounts.searchDataSources

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

  • accounts.searchFolders

    Searches the subfolders in a folder.

  • accounts.searchGroups

    Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

  • accounts.updateAccountCustomization

    Updates Amazon QuickSight customizations for the current Amazon Web Services Region. 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 Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

  • accounts.updateAccountSettings

    Updates the Amazon QuickSight settings in your Amazon Web Services account.

  • accounts.updateAnalysis

    Updates an analysis in Amazon QuickSight

  • accounts.updateAnalysisPermissions

    Updates the read and write permissions for an analysis.

  • accounts.updateDashboard

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

  • accounts.updateDashboardPermissions

    Updates read and write permissions on a dashboard.

  • accounts.updateDashboardPublishedVersion

    Updates the published version of a dashboard.

  • accounts.updateDataSet

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

  • accounts.updateDataSetPermissions

    Updates the permissions on a dataset.

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

  • accounts.updateDataSource

    Updates a data source.

  • accounts.updateDataSourcePermissions

    Updates the permissions to a data source.

  • accounts.updateFolder

    Updates the name of a folder.

  • accounts.updateFolderPermissions

    Updates permissions of a folder.

  • accounts.updateGroup

    Changes a group description.

  • accounts.updateIamPolicyAssignment

    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.

  • accounts.updateIpRestriction

    Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

  • accounts.updatePublicSharingSettings

    Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

    To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

    Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see in the Amazon QuickSight User Guide.

  • accounts.updateRefreshSchedule

    Updates a refresh schedule for a dataset.

  • accounts.updateTemplate

    Updates a template from an existing Amazon QuickSight analysis or another template.

  • accounts.updateTemplateAlias

    Updates the template alias of a template.

  • accounts.updateTemplatePermissions

    Updates the resource permissions for a template.

  • accounts.updateTheme

    Updates a theme.

  • accounts.updateThemeAlias

    Updates an alias of a theme.

  • accounts.updateThemePermissions

    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 permissions:

    • User

      • "quicksight:DescribeTheme"

      • "quicksight:DescribeThemeAlias"

      • "quicksight:ListThemeAliases"

      • "quicksight:ListThemeVersions"

    • Owner

      • "quicksight:DescribeTheme"

      • "quicksight:DescribeThemeAlias"

      • "quicksight:ListThemeAliases"

      • "quicksight:ListThemeVersions"

      • "quicksight:DeleteTheme"

      • "quicksight:UpdateTheme"

      • "quicksight:CreateThemeAlias"

      • "quicksight:DeleteThemeAlias"

      • "quicksight:UpdateThemeAlias"

      • "quicksight:UpdateThemePermissions"

      • "quicksight:DescribeThemePermissions"

    • To specify no permissions, omit the permissions list.

  • accounts.updateUser

    Updates an Amazon QuickSight user.

  • resources.listTagsForResource

    Lists the tags assigned to a resource.

  • resources.tagResource

    Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight 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 the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

    You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.

    Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:

    • You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.

    • Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

  • resources.untagResource

    Removes a tag or tags from a resource.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools