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: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html 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.

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 Sign up for Amazon Web Services: https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html 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 IAM Policy Examples for Amazon QuickSight: https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html 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 Passing IAM roles to Amazon QuickSight: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role in the Amazon QuickSight User Guide.

Creates an analysis in Amazon QuickSight.

Creates a dashboard from either a template or directly with a DashboardDefinition.

To first create a template, see the CreateTemplate: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html API operation.

Creates a dataset.

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.

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

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).

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.

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

Creates a refresh schedule for a dataset.

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.

Creates a theme.

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account.

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.

Deletes the data source permanently.

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

Deletes a namespace and the users and groups that are associated with the namespace.

Deletes the item that the specified template alias points to.

Deletes the version of the theme that the specified theme alias points to.

Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.

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 command line options: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html.

  • Use named profiles: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

  • 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 Configuring the CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html.

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

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.

Provides a detailed description of the definition of an analysis.

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Describes an existing import job.

Provides a detailed description of the definition of a dashboard.

Describes an existing snapshot job.

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

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

Describes a dataset.

Describes the permissions on a dataset.

Describes the folder resolved permissions.

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.

Provides a detailed description of the definition of a template.

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 SessionLifetimeInMinutes: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes 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 Embedded Analytics: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html in the Amazon QuickSight User Guide.

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 SessionLifetimeInMinutes: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes 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 Embedded Analytics: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html in the Amazon QuickSight User Guide.

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 Embedding Analytics Using GetDashboardEmbedUrl: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html in the Amazon QuickSight User Guide.

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

• Embedding Analytics: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html

• Customizing Access to the Amazon QuickSight Console: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html

Lists all asset bundle export jobs that have been taken place in the last 14 days.

Lists all asset bundle import jobs that have taken place in the last 14 days.

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

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

Lists the namespaces for the specified Amazon Web Services account.

Lists the refresh schedules of a dataset.

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.

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

Searches for dashboards that belong to a user.

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

Starts an asynchronous job that generates a dashboard snapshot.

You can request one of the following format configurations per API call.

• 1 paginated PDF

• 1 Excel workbook

• 5 CSVs

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, template, topic, and user.

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

• Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

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

Updates Amazon QuickSight customizations for the current Amazon Web Services Region.

Currently, the only customization that you can use is a theme.

Updates a dashboard in an Amazon Web Services account.

Updates a dataset.

Updates the permissions on a dataset.

Updates an existing IAM policy assignment.

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

Updates the content and status of IP rules.

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.

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.