QuickSightClient

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.

Properties

Link copied to clipboard
abstract override val config: QuickSightClient.Config

QuickSightClient's configuration

Functions

Link copied to clipboard

Creates new reviewed answers for a Q Topic.

Link copied to clipboard
Link copied to clipboard

Cancels an ongoing ingestion of data into SPICE.

Link copied to clipboard

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 Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createBrand(input: CreateBrandRequest): CreateBrandResponse

Creates an Amazon QuickSight brand.

Link copied to clipboard

Creates a custom permissions profile.

Link copied to clipboard

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> API operation.

Link copied to clipboard

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

Link copied to clipboard

Creates a data source.

Link copied to clipboard

Creates an empty shared folder.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createGroup(input: CreateGroupRequest): CreateGroupResponse

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 Amazon Web Services Support.

Link copied to clipboard

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

Link copied to clipboard

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.

Link copied to clipboard

Creates a template alias for a template.

Link copied to clipboard
abstract suspend fun createTheme(input: CreateThemeRequest): CreateThemeResponse

Creates a theme.

Link copied to clipboard

Creates a theme alias for a theme.

Link copied to clipboard
abstract suspend fun createTopic(input: CreateTopicRequest): CreateTopicResponse

Creates a new Q topic.

Link copied to clipboard

Creates a topic refresh schedule.

Link copied to clipboard

Creates a new VPC connection.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun deleteBrand(input: DeleteBrandRequest): DeleteBrandResponse

Deletes an Amazon QuickSight brand.

Link copied to clipboard

Deletes a brand assignment.

Link copied to clipboard

Deletes a custom permissions profile.

Link copied to clipboard

Deletes a dashboard.

Link copied to clipboard

Deletes a dataset.

Link copied to clipboard

Deletes the dataset refresh properties of the dataset.

Link copied to clipboard

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

Link copied to clipboard

Deletes a linked Amazon Q Business application from an Amazon QuickSight account

Link copied to clipboard

Deletes an empty folder.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun deleteGroup(input: DeleteGroupRequest): DeleteGroupResponse

Removes a user group from Amazon QuickSight.

Link copied to clipboard

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

Link copied to clipboard

Deletes an existing IAM policy assignment.

Link copied to clipboard

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a refresh schedule from a dataset.

Link copied to clipboard

Removes custom permissions from the role.

Link copied to clipboard

Removes a group from a role.

Link copied to clipboard

Deletes a template.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun deleteTheme(input: DeleteThemeRequest): DeleteThemeResponse

Deletes a theme.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun deleteTopic(input: DeleteTopicRequest): DeleteTopicResponse

Deletes a topic.

Link copied to clipboard

Deletes a topic refresh schedule.

Link copied to clipboard
abstract suspend fun deleteUser(input: DeleteUserRequest): DeleteUserResponse

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.

Link copied to clipboard

Deletes a user identified by its principal ID.

Link copied to clipboard

Deletes a custom permissions profile from a user.

Link copied to clipboard

Deletes a VPC connection.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Provides a summary of the metadata for an analysis.

Link copied to clipboard

Provides a detailed description of the definition of an analysis.

Link copied to clipboard

Provides the read and write permissions for an analysis.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes a brand.

Link copied to clipboard

Describes a brand assignment.

Link copied to clipboard

Describes the published version of the brand.

Link copied to clipboard

Describes a custom permissions profile.

Link copied to clipboard

Provides a summary for a dashboard.

Link copied to clipboard

Provides a detailed description of the definition of a dashboard.

Link copied to clipboard

Describes read and write permissions for a dashboard.

Link copied to clipboard

Describes an existing snapshot job.

Link copied to clipboard

Describes the result of an existing snapshot job that has finished running.

Link copied to clipboard

Describes an existing dashboard QA configuration.

Link copied to clipboard

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

Link copied to clipboard

Describes the permissions on a dataset.

Link copied to clipboard

Describes the refresh properties of a dataset.

Link copied to clipboard

Describes a data source.

Link copied to clipboard

Describes the resource permissions for a data source.

Link copied to clipboard

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

Link copied to clipboard

Describes a folder.

Link copied to clipboard

Describes permissions for a folder.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Describes a SPICE ingestion.

Link copied to clipboard

Provides a summary and status of IP rules.

Link copied to clipboard

Describes all customer managed key registrations in a Amazon QuickSight account.

Link copied to clipboard

Describes the current namespace.

Link copied to clipboard

Describes the state of a Amazon QuickSight Q Search configuration.

Link copied to clipboard

Provides a summary of a refresh schedule.

Link copied to clipboard

Describes all custom permissions that are mapped to a role.

Link copied to clipboard

Describes a template's metadata.

Link copied to clipboard

Describes the template alias for a template.

Link copied to clipboard

Provides a detailed description of the definition of a template.

Link copied to clipboard

Describes read and write permissions on a template.

Link copied to clipboard

Describes a theme.

Link copied to clipboard

Describes the alias for a theme.

Link copied to clipboard

Describes the read and write permissions for a theme.

Link copied to clipboard

Describes a topic.

Link copied to clipboard

Describes the permissions of a topic.

Link copied to clipboard

Describes the status of a topic refresh.

Link copied to clipboard
Link copied to clipboard

Returns information about a user, given the user name.

Link copied to clipboard

Describes a VPC connection.

Link copied to clipboard

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.

Link copied to clipboard

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.

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 that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

Link copied to clipboard

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.

Link copied to clipboard

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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> API operation. Use <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a> 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:

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun listBrands(input: ListBrandsRequest): ListBrandsResponse

Lists all brands in an Amazon QuickSight account.

Link copied to clipboard

Returns a list of all the custom permissions profiles.

Link copied to clipboard

Lists dashboards in an Amazon Web Services account.

Link copied to clipboard

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

Link copied to clipboard

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listFolders(input: ListFoldersRequest): ListFoldersResponse

Lists all folders in an account.

Link copied to clipboard

List all folders that a resource is a member of.

Link copied to clipboard

Lists member users in a group.

Link copied to clipboard
abstract suspend fun listGroups(input: ListGroupsRequest): ListGroupsResponse

Lists all user groups in Amazon QuickSight.

Link copied to clipboard

Lists the IAM policy assignments in the current Amazon QuickSight account.

Link copied to clipboard

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.

Link copied to clipboard

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists all groups that are associated with a role.

Link copied to clipboard

Lists the tags assigned to a resource.

Link copied to clipboard

Lists all the aliases of a template.

Link copied to clipboard

Lists all the templates in the current Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Lists all the aliases of a theme.

Link copied to clipboard
abstract suspend fun listThemes(input: ListThemesRequest): ListThemesResponse

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

Link copied to clipboard

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

Link copied to clipboard

Lists all of the refresh schedules for a topic.

Link copied to clipboard

Lists all reviewed answers for a Q Topic.

Link copied to clipboard
abstract suspend fun listTopics(input: ListTopicsRequest): ListTopicsResponse

Lists all of the topics within an account.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listUsers(input: ListUsersRequest): ListUsersResponse

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

Link copied to clipboard

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

Link copied to clipboard

Predicts existing visuals or generates new visuals to answer a given query.

Link copied to clipboard

Creates or updates the dataset refresh properties for the dataset.

Link copied to clipboard

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 Inviting users to access Amazon QuickSight.

Link copied to clipboard

Restores an analysis.

Link copied to clipboard

Searches for analyses that belong to the user specified in the filter.

Link copied to clipboard

Searches for dashboards that belong to a user.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Searches the subfolders in a folder.

Link copied to clipboard

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

Link copied to clipboard

Searches for any Q topic that exists in an Amazon QuickSight account.

Link copied to clipboard

Starts an Asset Bundle export job.

Link copied to clipboard

Starts an Asset Bundle import job.

Link copied to clipboard

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.

Link copied to clipboard

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

Link copied to clipboard

Removes a tag or tags from a resource.

Link copied to clipboard

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

Link copied to clipboard

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

Link copied to clipboard

Updates an analysis in Amazon QuickSight

Link copied to clipboard

Updates the read and write permissions for an analysis.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateBrand(input: UpdateBrandRequest): UpdateBrandResponse

Updates a brand.

Link copied to clipboard

Updates a brand assignment.

Link copied to clipboard

Updates the published version of a brand.

Link copied to clipboard

Updates a custom permissions profile.

Link copied to clipboard

Updates a dashboard in an Amazon Web Services account.

Link copied to clipboard

Updates the linked analyses on a dashboard.

Link copied to clipboard

Updates read and write permissions on a dashboard.

Link copied to clipboard

Updates the published version of a dashboard.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Updates the permissions on a dataset.

Link copied to clipboard

Updates a data source.

Link copied to clipboard

Updates the permissions to a data source.

Link copied to clipboard

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

Link copied to clipboard

Updates the name of a folder.

Link copied to clipboard

Updates permissions of a folder.

Link copied to clipboard
abstract suspend fun updateGroup(input: UpdateGroupRequest): UpdateGroupResponse

Changes a group description.

Link copied to clipboard

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.

Link copied to clipboard

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

Link copied to clipboard

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 to get the current rule map.

Link copied to clipboard

Updates a customer managed key in a Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Updates the state of a Amazon QuickSight Q Search configuration.

Link copied to clipboard

Updates a refresh schedule for a dataset.

Link copied to clipboard

Updates the custom permissions that are associated with a role.

Link copied to clipboard

Updates the SPICE capacity configuration for a Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Updates the template alias of a template.

Link copied to clipboard

Updates the resource permissions for a template.

Link copied to clipboard
abstract suspend fun updateTheme(input: UpdateThemeRequest): UpdateThemeResponse

Updates a theme.

Link copied to clipboard

Updates an alias of a theme.

Link copied to clipboard

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Link copied to clipboard
abstract suspend fun updateTopic(input: UpdateTopicRequest): UpdateTopicResponse

Updates a topic.

Link copied to clipboard

Updates the permissions of a topic.

Link copied to clipboard

Updates a topic refresh schedule.

Link copied to clipboard
abstract suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse

Updates an Amazon QuickSight user.

Link copied to clipboard

Updates a custom permissions profile for a user.

Link copied to clipboard

Updates a VPC connection.

Inherited functions

Link copied to clipboard

Creates new reviewed answers for a Q Topic.

Link copied to clipboard
Link copied to clipboard

Cancels an ongoing ingestion of data into SPICE.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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 Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Creates an Amazon QuickSight brand.

Link copied to clipboard

Creates a custom permissions profile.

Link copied to clipboard

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> API operation.

Link copied to clipboard

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

Link copied to clipboard

Creates a data source.

Link copied to clipboard

Creates an empty shared folder.

Link copied to clipboard

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

Link copied to clipboard

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 Amazon Web Services Support.

Link copied to clipboard

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

Link copied to clipboard

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.

Link copied to clipboard

Creates a template alias for a template.

Link copied to clipboard

Creates a theme.

Link copied to clipboard

Creates a theme alias for a theme.

Link copied to clipboard

Creates a new Q topic.

Link copied to clipboard

Creates a topic refresh schedule.

Link copied to clipboard

Creates a new VPC connection.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes an Amazon QuickSight brand.

Link copied to clipboard

Deletes a brand assignment.

Link copied to clipboard

Deletes a custom permissions profile.

Link copied to clipboard

Deletes a dashboard.

Link copied to clipboard

Deletes a dataset.

Link copied to clipboard

Deletes the dataset refresh properties of the dataset.

Link copied to clipboard

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

Link copied to clipboard

Deletes a linked Amazon Q Business application from an Amazon QuickSight account

Link copied to clipboard

Deletes an empty folder.

Link copied to clipboard

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

Link copied to clipboard

Removes a user group from Amazon QuickSight.

Link copied to clipboard

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

Link copied to clipboard

Deletes an existing IAM policy assignment.

Link copied to clipboard

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a refresh schedule from a dataset.

Link copied to clipboard

Removes custom permissions from the role.

Link copied to clipboard

Removes a group from a role.

Link copied to clipboard

Deletes a template.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a theme.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a topic.

Link copied to clipboard

Deletes a topic refresh schedule.

Link copied to clipboard
inline suspend fun QuickSightClient.deleteUser(crossinline block: DeleteUserRequest.Builder.() -> Unit): DeleteUserResponse

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.

Link copied to clipboard

Deletes a user identified by its principal ID.

Link copied to clipboard

Deletes a custom permissions profile from a user.

Link copied to clipboard

Deletes a VPC connection.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Provides a summary of the metadata for an analysis.

Link copied to clipboard

Provides a detailed description of the definition of an analysis.

Link copied to clipboard

Provides the read and write permissions for an analysis.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes a brand.

Link copied to clipboard

Describes a brand assignment.

Link copied to clipboard

Describes the published version of the brand.

Link copied to clipboard

Describes a custom permissions profile.

Link copied to clipboard

Provides a summary for a dashboard.

Link copied to clipboard

Provides a detailed description of the definition of a dashboard.

Link copied to clipboard

Describes read and write permissions for a dashboard.

Link copied to clipboard

Describes an existing snapshot job.

Link copied to clipboard

Describes the result of an existing snapshot job that has finished running.

Link copied to clipboard

Describes an existing dashboard QA configuration.

Link copied to clipboard

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

Link copied to clipboard

Describes the permissions on a dataset.

Link copied to clipboard

Describes the refresh properties of a dataset.

Link copied to clipboard

Describes a data source.

Link copied to clipboard

Describes the resource permissions for a data source.

Link copied to clipboard

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

Link copied to clipboard

Describes a folder.

Link copied to clipboard

Describes permissions for a folder.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Describes a SPICE ingestion.

Link copied to clipboard

Provides a summary and status of IP rules.

Link copied to clipboard

Describes all customer managed key registrations in a Amazon QuickSight account.

Link copied to clipboard

Describes the current namespace.

Link copied to clipboard

Describes the state of a Amazon QuickSight Q Search configuration.

Link copied to clipboard

Provides a summary of a refresh schedule.

Link copied to clipboard

Describes all custom permissions that are mapped to a role.

Link copied to clipboard

Describes a template's metadata.

Link copied to clipboard

Describes the template alias for a template.

Link copied to clipboard

Provides a detailed description of the definition of a template.

Link copied to clipboard

Describes read and write permissions on a template.

Link copied to clipboard

Describes a theme.

Link copied to clipboard

Describes the alias for a theme.

Link copied to clipboard

Describes the read and write permissions for a theme.

Link copied to clipboard

Describes a topic.

Link copied to clipboard

Describes the permissions of a topic.

Link copied to clipboard

Describes the status of a topic refresh.

Link copied to clipboard
Link copied to clipboard

Returns information about a user, given the user name.

Link copied to clipboard

Describes a VPC connection.

Link copied to clipboard

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.

Link copied to clipboard

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.

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 that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

Link copied to clipboard

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.

Link copied to clipboard

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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> API operation. Use <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a> 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:

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun QuickSightClient.listBrands(crossinline block: ListBrandsRequest.Builder.() -> Unit): ListBrandsResponse

Lists all brands in an Amazon QuickSight account.

Link copied to clipboard

Returns a list of all the custom permissions profiles.

Link copied to clipboard

Lists dashboards in an Amazon Web Services account.

Link copied to clipboard

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

Link copied to clipboard

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists all folders in an account.

Link copied to clipboard

List all folders that a resource is a member of.

Link copied to clipboard

Lists member users in a group.

Link copied to clipboard
inline suspend fun QuickSightClient.listGroups(crossinline block: ListGroupsRequest.Builder.() -> Unit): ListGroupsResponse

Lists all user groups in Amazon QuickSight.

Link copied to clipboard

Lists the IAM policy assignments in the current Amazon QuickSight account.

Link copied to clipboard

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.

Link copied to clipboard

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists all groups that are associated with a role.

Link copied to clipboard

Lists the tags assigned to a resource.

Link copied to clipboard

Lists all the aliases of a template.

Link copied to clipboard

Lists all the templates in the current Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Lists all the aliases of a theme.

Link copied to clipboard
inline suspend fun QuickSightClient.listThemes(crossinline block: ListThemesRequest.Builder.() -> Unit): ListThemesResponse

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

Link copied to clipboard

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

Link copied to clipboard

Lists all of the refresh schedules for a topic.

Link copied to clipboard

Lists all reviewed answers for a Q Topic.

Link copied to clipboard
inline suspend fun QuickSightClient.listTopics(crossinline block: ListTopicsRequest.Builder.() -> Unit): ListTopicsResponse

Lists all of the topics within an account.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun QuickSightClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

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

Link copied to clipboard

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

Link copied to clipboard

Predicts existing visuals or generates new visuals to answer a given query.

Link copied to clipboard

Creates or updates the dataset refresh properties for the dataset.

Link copied to clipboard

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 Inviting users to access Amazon QuickSight.

Link copied to clipboard

Restores an analysis.

Link copied to clipboard

Searches for analyses that belong to the user specified in the filter.

Link copied to clipboard

Searches for dashboards that belong to a user.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Searches the subfolders in a folder.

Link copied to clipboard

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

Link copied to clipboard

Searches for any Q topic that exists in an Amazon QuickSight account.

Link copied to clipboard

Starts an Asset Bundle export job.

Link copied to clipboard

Starts an Asset Bundle import job.

Link copied to clipboard

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.

Link copied to clipboard

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

Link copied to clipboard

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

Link copied to clipboard

Removes a tag or tags from a resource.

Link copied to clipboard

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

Link copied to clipboard

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

Link copied to clipboard

Updates an analysis in Amazon QuickSight

Link copied to clipboard

Updates the read and write permissions for an analysis.

Link copied to clipboard

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

Link copied to clipboard

Updates a brand.

Link copied to clipboard

Updates a brand assignment.

Link copied to clipboard

Updates the published version of a brand.

Link copied to clipboard

Updates a custom permissions profile.

Link copied to clipboard

Updates a dashboard in an Amazon Web Services account.

Link copied to clipboard

Updates the linked analyses on a dashboard.

Link copied to clipboard

Updates read and write permissions on a dashboard.

Link copied to clipboard

Updates the published version of a dashboard.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Updates the permissions on a dataset.

Link copied to clipboard

Updates a data source.

Link copied to clipboard

Updates the permissions to a data source.

Link copied to clipboard

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

Link copied to clipboard

Updates the name of a folder.

Link copied to clipboard

Updates permissions of a folder.

Link copied to clipboard

Changes a group description.

Link copied to clipboard

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.

Link copied to clipboard

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

Link copied to clipboard

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 to get the current rule map.

Link copied to clipboard

Updates a customer managed key in a Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Updates the state of a Amazon QuickSight Q Search configuration.

Link copied to clipboard

Updates a refresh schedule for a dataset.

Link copied to clipboard

Updates the custom permissions that are associated with a role.

Link copied to clipboard

Updates the SPICE capacity configuration for a Amazon QuickSight account.

Link copied to clipboard

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

Link copied to clipboard

Updates the template alias of a template.

Link copied to clipboard

Updates the resource permissions for a template.

Link copied to clipboard

Updates a theme.

Link copied to clipboard

Updates an alias of a theme.

Link copied to clipboard

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Link copied to clipboard

Updates a topic.

Link copied to clipboard

Updates the permissions of a topic.

Link copied to clipboard

Updates a topic refresh schedule.

Link copied to clipboard
inline suspend fun QuickSightClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

Updates an Amazon QuickSight user.

Link copied to clipboard

Updates a custom permissions profile for a user.

Link copied to clipboard

Updates a VPC connection.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.