(constructor)

[configuration]

Constructs a new instance of the <code>QuickSightClient</code> class

config

The resolved configuration of QuickSightClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-quicksight!QuickSightClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

QuickSightClient

<fullname>Amazon QuickSight API Reference</fullname> 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.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

BatchCreateTopicReviewedAnswerCommand

Creates new reviewed answers for a Q Topic.

BatchDeleteTopicReviewedAnswerCommand

Deletes reviewed answers for Q Topic.

CancelIngestionCommand

Cancels an ongoing ingestion of data into SPICE.

CreateAccountCustomizationCommand

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code> API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing Amazon QuickSight</a> 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 <code>DescribeAccountCustomization</code> API operation. Before you use the <code>CreateAccountCustomization</code> 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 <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html">DescribeThemePermissions</a> </code> API operation. To share the theme, grant permissions by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html">UpdateThemePermissions</a> </code> API operation.

CreateAccountSubscriptionCommand

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. 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html">Sign up for Amazon Web Services</a> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html">IAM Policy Examples for Amazon QuickSight</a> in the Amazon QuickSight User Guide. If your IAM policy includes both the <code>Subscribe</code> and <code>CreateAccountSubscription</code> actions, make sure that both actions are set to <code>Allow</code>. If either action is set to <code>Deny</code>, the <code>Deny</code> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role">Passing IAM roles to Amazon QuickSight</a> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html">Setting default resource access to Amazon Web Services services</a> in the Amazon QuickSight User Guide.

CreateAnalysisCommand

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

CreateBrandCommand

Creates an Amazon QuickSight brand.

CreateCustomPermissionsCommand

Creates a custom permissions profile.

CreateDashboardCommand

Creates a dashboard from either a template or directly with a <code>DashboardDefinition</code>. To first create a template, see the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> 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.

CreateDataSetCommand

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

CreateDataSourceCommand

CreateFolderCommand

CreateFolderMembershipCommand

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

CreateGroupCommand

Use the <code>CreateGroup</code> 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. The permissions resource is <code>arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> </code>. The response is a group object.

CreateGroupMembershipCommand

Adds an Amazon QuickSight user to an Amazon QuickSight group.

CreateIAMPolicyAssignmentCommand

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.

CreateIngestionCommand

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 <a href="http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

CreateNamespaceCommand

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

CreateRefreshScheduleCommand

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

CreateRoleMembershipCommand

Use <code>CreateRoleMembership</code> to add an existing Amazon QuickSight group to an existing role.

CreateTemplateAliasCommand

Creates a template alias for a template.

CreateTemplateCommand

Creates a template either from a <code>TemplateDefinition</code> 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.

CreateThemeAliasCommand

Creates a theme alias for a theme.

CreateThemeCommand

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using Themes in Amazon QuickSight</a> in the Amazon QuickSight User Guide.

CreateTopicCommand

CreateTopicRefreshScheduleCommand

CreateVPCConnectionCommand

DeleteAccountCustomizationCommand

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

DeleteAccountSubscriptionCommand

Use the <code>DeleteAccountSubscription</code> 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 <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.

DeleteAnalysisCommand

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 <code>DeletionTime</code> 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 <code>RestoreAnalysis</code> API operation to remove the <code>DeletionTime</code> 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.

DeleteBrandAssignmentCommand

DeleteBrandCommand

Deletes an Amazon QuickSight brand.

DeleteCustomPermissionsCommand

Deletes a custom permissions profile.

DeleteDashboardCommand

DeleteDataSetCommand

DeleteDataSetRefreshPropertiesCommand

Deletes the dataset refresh properties of the dataset.

DeleteDataSourceCommand

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

DeleteDefaultQBusinessApplicationCommand

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

DeleteFolderCommand

DeleteFolderMembershipCommand

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

DeleteGroupCommand

Removes a user group from Amazon QuickSight.

DeleteGroupMembershipCommand

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

DeleteIAMPolicyAssignmentCommand

Deletes an existing IAM policy assignment.

DeleteIdentityPropagationConfigCommand

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

DeleteNamespaceCommand

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.

DeleteRefreshScheduleCommand

Deletes a refresh schedule from a dataset.

DeleteRoleCustomPermissionCommand

Removes custom permissions from the role.

DeleteRoleMembershipCommand

DeleteTemplateAliasCommand

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.

DeleteTemplateCommand

DeleteThemeAliasCommand

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.

DeleteThemeCommand

DeleteTopicCommand

DeleteTopicRefreshScheduleCommand

DeleteUserByPrincipalIdCommand

Deletes a user identified by its principal ID.

DeleteUserCommand

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.

DeleteUserCustomPermissionCommand

Deletes a custom permissions profile from a user.

DeleteVPCConnectionCommand

DescribeAccountCustomizationCommand

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 <code>Resolved</code> flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. <ul> <li> <code>Amazon Web Services account</code> - 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. </li> <li> <code>Amazon Web Services Region</code> - 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: <ul> <li> Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </li> <li> Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html">named profiles</a>. </li> <li> Run <code>aws configure</code> to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>. </li> </ul> </li> <li> <code>Namespace</code> - 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. </li> <li> <code>Applied customizations</code> - 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 <code>CreateAccountCustomization</code> command in each Amazon Web Services Region where you want to apply the same customizations. </li> </ul>

DescribeAccountSettingsCommand

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

DescribeAccountSubscriptionCommand

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

DescribeAnalysisCommand

Provides a summary of the metadata for an analysis.

DescribeAnalysisDefinitionCommand

Provides a detailed description of the definition of an analysis. <note> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html"> <code>DescribeAnalysis</code> </a> instead. </note>

DescribeAnalysisPermissionsCommand

Provides the read and write permissions for an analysis.

DescribeAssetBundleExportJobCommand

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 <code>DescribeAssetBundleExportJob</code> API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.

DescribeAssetBundleImportJobCommand

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.

DescribeBrandAssignmentCommand

DescribeBrandCommand

DescribeBrandPublishedVersionCommand

Describes the published version of the brand.

DescribeCustomPermissionsCommand

Describes a custom permissions profile.

DescribeDashboardCommand

Provides a summary for a dashboard.

DescribeDashboardDefinitionCommand

Provides a detailed description of the definition of a dashboard. <note> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html"> <code>DescribeDashboard</code> </a> instead. </note>

DescribeDashboardPermissionsCommand

Describes read and write permissions for a dashboard.

DescribeDashboardSnapshotJobCommand

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 <code>JobStatus</code>.

DescribeDashboardSnapshotJobResultCommand

Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a <code>COMPLETED</code> or <code>FAILED</code> status when you poll the job with a <code>DescribeDashboardSnapshotJob</code> API call. If the job has not finished running, this operation returns a message that says <code>Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.</code>.

DescribeDashboardsQAConfigurationCommand

Describes an existing dashboard QA configuration.

DescribeDataSetCommand

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

DescribeDataSetPermissionsCommand

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

DescribeDataSetRefreshPropertiesCommand

Describes the refresh properties of a dataset.

DescribeDataSourceCommand

DescribeDataSourcePermissionsCommand

Describes the resource permissions for a data source.

DescribeDefaultQBusinessApplicationCommand

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

DescribeFolderCommand

DescribeFolderPermissionsCommand

Describes permissions for a folder.

DescribeFolderResolvedPermissionsCommand

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

DescribeGroupCommand

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

DescribeGroupMembershipCommand

Use the <code>DescribeGroupMembership</code> 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 <code>GroupMember</code> object is returned.

DescribeIAMPolicyAssignmentCommand

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

DescribeIngestionCommand

DescribeIpRestrictionCommand

Provides a summary and status of IP rules.

DescribeKeyRegistrationCommand

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

DescribeNamespaceCommand

DescribeQPersonalizationConfigurationCommand

Describes a personalization configuration.

DescribeQuickSightQSearchConfigurationCommand

Describes the state of a Amazon QuickSight Q Search configuration.

DescribeRefreshScheduleCommand

Provides a summary of a refresh schedule.

DescribeRoleCustomPermissionCommand

Describes all custom permissions that are mapped to a role.