View Source AWS.QuickSight (aws-elixir v0.13.1)

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.

Link to this section Summary

Functions

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

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

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

Use the CreateGroup operation to create a group in Amazon QuickSight.

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

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

Creates a template from an existing Amazon QuickSight analysis or template.

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

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

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

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 Identity and Access Management (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.

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

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

Provides a summary of the metadata for an analysis.

Provides the read and write permissions for an analysis.

Describes read and write permissions for a dashboard.

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

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

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

Provides a summary and status of IP rules.

Describes read and write permissions on a template.

Describes the read and write permissions for a theme.

Returns information about a user, given the user name.

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.

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.

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

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

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

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

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

Lists the namespaces for the specified Amazon Web Services account.

Lists the tags assigned to a resource.

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

Lists all the templates in the current Amazon QuickSight account.

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

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

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

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.

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

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

Removes a tag or tags from a resource.

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

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

Updates the read and write permissions for an analysis.

Updates a dashboard in an Amazon Web Services account.

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.

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

Link to this section Functions

Link to this function

cancel_ingestion(client, aws_account_id, data_set_id, ingestion_id, input, options \\ [])

View Source

Cancels an ongoing ingestion of data into SPICE.

Link to this function

create_account_customization(client, aws_account_id, input, options \\ [])

View Source

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.

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

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the [DescribeThemePermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html) API operation. To share the theme, grant permissions by using the [UpdateThemePermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html) API operation.

Link to this function

create_account_subscription(client, aws_account_id, input, options \\ [])

View Source

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

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

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services 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 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 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 Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.

Link to this function

create_analysis(client, analysis_id, aws_account_id, input, options \\ [])

View Source

Creates an analysis in Amazon QuickSight.

Link to this function

create_dashboard(client, aws_account_id, dashboard_id, input, options \\ [])

View Source

Creates a dashboard from a template.

To first create a template, see the [CreateTemplate](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html) 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.

Link to this function

create_data_set(client, aws_account_id, input, options \\ [])

View Source

Creates a dataset.

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

Link to this function

create_data_source(client, aws_account_id, input, options \\ [])

View Source

Creates a data source.

Link to this function

create_folder(client, aws_account_id, folder_id, input, options \\ [])

View Source

Creates an empty shared folder.

Link to this function

create_folder_membership( client, aws_account_id, folder_id, member_id, member_type, input, options \\ [] )

View Source

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

Link to this function

create_group(client, aws_account_id, namespace, input, options \\ [])

View Source

Use the CreateGroup operation to create a group in Amazon QuickSight.

You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

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

The response is a group object.

Link to this function

create_group_membership( client, aws_account_id, group_name, member_name, namespace, input, options \\ [] )

View Source

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Link to this function

create_iam_policy_assignment(client, aws_account_id, namespace, input, options \\ [])

View Source

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 to this function

create_ingestion(client, aws_account_id, data_set_id, ingestion_id, input, options \\ [])

View Source

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 How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Link to this function

create_namespace(client, aws_account_id, input, options \\ [])

View Source

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

Link to this function

create_template(client, aws_account_id, template_id, input, options \\ [])

View Source

Creates a template from an existing Amazon QuickSight analysis or template.

You can use the resulting template to create a dashboard.

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.

Link to this function

create_template_alias(client, alias_name, aws_account_id, template_id, input, options \\ [])

View Source

Creates a template alias for a template.

Link to this function

create_theme(client, aws_account_id, theme_id, input, options \\ [])

View Source

Creates a theme.

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

Link to this function

create_theme_alias(client, alias_name, aws_account_id, theme_id, input, options \\ [])

View Source

Creates a theme alias for a theme.

Link to this function

delete_account_customization(client, aws_account_id, input, options \\ [])

View Source

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

Link to this function

delete_analysis(client, analysis_id, aws_account_id, input, options \\ [])

View Source

Deletes an analysis from Amazon QuickSight.

You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.

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

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

Link to this function

delete_dashboard(client, aws_account_id, dashboard_id, input, options \\ [])

View Source

Deletes a dashboard.

Link to this function

delete_data_set(client, aws_account_id, data_set_id, input, options \\ [])

View Source

Deletes a dataset.

Link to this function

delete_data_source(client, aws_account_id, data_source_id, input, options \\ [])

View Source

Deletes the data source permanently.

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

Link to this function

delete_folder(client, aws_account_id, folder_id, input, options \\ [])

View Source

Deletes an empty folder.

Link to this function

delete_folder_membership( client, aws_account_id, folder_id, member_id, member_type, input, options \\ [] )

View Source

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

Link to this function

delete_group(client, aws_account_id, group_name, namespace, input, options \\ [])

View Source

Removes a user group from Amazon QuickSight.

Link to this function

delete_group_membership( client, aws_account_id, group_name, member_name, namespace, input, options \\ [] )

View Source

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

Link to this function

delete_iam_policy_assignment( client, assignment_name, aws_account_id, namespace, input, options \\ [] )

View Source

Deletes an existing IAM policy assignment.

Link to this function

delete_namespace(client, aws_account_id, namespace, input, options \\ [])

View Source

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 to this function

delete_template(client, aws_account_id, template_id, input, options \\ [])

View Source

Deletes a template.

Link to this function

delete_template_alias(client, alias_name, aws_account_id, template_id, input, options \\ [])

View Source

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 to this function

delete_theme(client, aws_account_id, theme_id, input, options \\ [])

View Source

Deletes a theme.

Link to this function

delete_theme_alias(client, alias_name, aws_account_id, theme_id, input, options \\ [])

View Source

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 to this function

delete_user(client, aws_account_id, namespace, user_name, input, options \\ [])

View Source

Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call.

The IAM user isn't deleted as a result of this call.

Link to this function

delete_user_by_principal_id(client, aws_account_id, namespace, principal_id, input, options \\ [])

View Source

Deletes a user identified by its principal ID.

Link to this function

describe_account_customization( client, aws_account_id, namespace \\ nil, resolved \\ nil, options \\ [] )

View Source

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.

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

Link to this function

describe_account_settings(client, aws_account_id, options \\ [])

View Source

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

Link to this function

describe_account_subscription(client, aws_account_id, options \\ [])

View Source

Use the DescribeAccountSubscription operation to receive a description of a 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 to this function

describe_analysis(client, analysis_id, aws_account_id, options \\ [])

View Source

Provides a summary of the metadata for an analysis.

Link to this function

describe_analysis_permissions(client, analysis_id, aws_account_id, options \\ [])

View Source

Provides the read and write permissions for an analysis.

Link to this function

describe_dashboard( client, aws_account_id, dashboard_id, alias_name \\ nil, version_number \\ nil, options \\ [] )

View Source

Provides a summary for a dashboard.

Link to this function

describe_dashboard_permissions(client, aws_account_id, dashboard_id, options \\ [])

View Source

Describes read and write permissions for a dashboard.

Link to this function

describe_data_set(client, aws_account_id, data_set_id, options \\ [])

View Source

Describes a dataset.

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

Link to this function

describe_data_set_permissions(client, aws_account_id, data_set_id, options \\ [])

View Source

Describes the permissions on a dataset.

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

Link to this function

describe_data_source(client, aws_account_id, data_source_id, options \\ [])

View Source

Describes a data source.

Link to this function

describe_data_source_permissions(client, aws_account_id, data_source_id, options \\ [])

View Source

Describes the resource permissions for a data source.

Link to this function

describe_folder(client, aws_account_id, folder_id, options \\ [])

View Source

Describes a folder.

Link to this function

describe_folder_permissions(client, aws_account_id, folder_id, options \\ [])

View Source

Describes permissions for a folder.

Link to this function

describe_folder_resolved_permissions(client, aws_account_id, folder_id, options \\ [])

View Source

Describes the folder resolved permissions.

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

Link to this function

describe_group(client, aws_account_id, group_name, namespace, options \\ [])

View Source

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

Link to this function

describe_group_membership( client, aws_account_id, group_name, member_name, namespace, options \\ [] )

View Source

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 to this function

describe_iam_policy_assignment(client, assignment_name, aws_account_id, namespace, options \\ [])

View Source

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

Link to this function

describe_ingestion(client, aws_account_id, data_set_id, ingestion_id, options \\ [])

View Source

Describes a SPICE ingestion.

Link to this function

describe_ip_restriction(client, aws_account_id, options \\ [])

View Source

Provides a summary and status of IP rules.

Link to this function

describe_namespace(client, aws_account_id, namespace, options \\ [])

View Source

Describes the current namespace.

Link to this function

describe_template( client, aws_account_id, template_id, alias_name \\ nil, version_number \\ nil, options \\ [] )

View Source

Describes a template's metadata.

Link to this function

describe_template_alias(client, alias_name, aws_account_id, template_id, options \\ [])

View Source

Describes the template alias for a template.

Link to this function

describe_template_permissions(client, aws_account_id, template_id, options \\ [])

View Source

Describes read and write permissions on a template.

Link to this function

describe_theme( client, aws_account_id, theme_id, alias_name \\ nil, version_number \\ nil, options \\ [] )

View Source

Describes a theme.

Link to this function

describe_theme_alias(client, alias_name, aws_account_id, theme_id, options \\ [])

View Source

Describes the alias for a theme.

Link to this function

describe_theme_permissions(client, aws_account_id, theme_id, options \\ [])

View Source

Describes the read and write permissions for a theme.

Link to this function

describe_user(client, aws_account_id, namespace, user_name, options \\ [])

View Source

Returns information about a user, given the user name.

Link to this function

generate_embed_url_for_anonymous_user(client, aws_account_id, input, options \\ [])

View Source

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

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

Link to this function

generate_embed_url_for_registered_user(client, aws_account_id, input, options \\ [])

View Source

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

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

Link to this function

get_dashboard_embed_url( client, aws_account_id, dashboard_id, additional_dashboard_ids \\ nil, identity_type, namespace \\ nil, reset_disabled \\ nil, session_lifetime_in_minutes \\ nil, state_persistence_enabled \\ nil, undo_redo_disabled \\ nil, user_arn \\ nil, options \\ [] )

View Source

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

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

Link to this function

get_session_embed_url( client, aws_account_id, entry_point \\ nil, session_lifetime_in_minutes \\ nil, user_arn \\ nil, options \\ [] )

View Source

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:

Link to this function

list_analyses(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_dashboard_versions( client, aws_account_id, dashboard_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

list_dashboards(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists dashboards in an Amazon Web Services account.

Link to this function

list_data_sets(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

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

Link to this function

list_data_sources(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_folder_members( client, aws_account_id, folder_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

list_folders(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all folders in an account.

Link to this function

list_group_memberships( client, aws_account_id, group_name, namespace, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists member users in a group.

Link to this function

list_groups( client, aws_account_id, namespace, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists all user groups in Amazon QuickSight.

Link to this function

list_iam_policy_assignments( client, aws_account_id, namespace, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists IAM policy assignments in the current Amazon QuickSight account.

Link to this function

list_iam_policy_assignments_for_user( client, aws_account_id, namespace, user_name, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

Link to this function

list_ingestions( client, aws_account_id, data_set_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists the history of SPICE ingestions for a dataset.

Link to this function

list_namespaces(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the namespaces for the specified Amazon Web Services account.

This operation doesn't list deleted namespaces.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags assigned to a resource.

Link to this function

list_template_aliases( client, aws_account_id, template_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists all the aliases of a template.

Link to this function

list_template_versions( client, aws_account_id, template_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

list_templates(client, aws_account_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all the templates in the current Amazon QuickSight account.

Link to this function

list_theme_aliases( client, aws_account_id, theme_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

Lists all the aliases of a theme.

Link to this function

list_theme_versions( client, aws_account_id, theme_id, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

list_themes( client, aws_account_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [] )

View Source

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

Link to this function

list_user_groups( client, aws_account_id, namespace, user_name, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

list_users( client, aws_account_id, namespace, max_results \\ nil, next_token \\ nil, options \\ [] )

View Source

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

Link to this function

register_user(client, aws_account_id, namespace, input, options \\ [])

View Source

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

Link to this function

restore_analysis(client, analysis_id, aws_account_id, input, options \\ [])

View Source

Restores an analysis.

Link to this function

search_analyses(client, aws_account_id, input, options \\ [])

View Source

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

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Link to this function

search_dashboards(client, aws_account_id, input, options \\ [])

View Source

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Link to this function

search_folders(client, aws_account_id, input, options \\ [])

View Source

Searches the subfolders in a folder.

Link to this function

search_groups(client, aws_account_id, namespace, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

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

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

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

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag or tags from a resource.

Link to this function

update_account_customization(client, aws_account_id, input, options \\ [])

View Source

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

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

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

Link to this function

update_account_settings(client, aws_account_id, input, options \\ [])

View Source

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

Link to this function

update_analysis(client, analysis_id, aws_account_id, input, options \\ [])

View Source

Updates an analysis in Amazon QuickSight

Link to this function

update_analysis_permissions(client, analysis_id, aws_account_id, input, options \\ [])

View Source

Updates the read and write permissions for an analysis.

Link to this function

update_dashboard(client, aws_account_id, dashboard_id, input, options \\ [])

View Source

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the [UpdateDashboardPublishedVersion](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html) API operation.

Link to this function

update_dashboard_permissions(client, aws_account_id, dashboard_id, input, options \\ [])

View Source

Updates read and write permissions on a dashboard.

Link to this function

update_dashboard_published_version( client, aws_account_id, dashboard_id, version_number, input, options \\ [] )

View Source

Updates the published version of a dashboard.

Link to this function

update_data_set(client, aws_account_id, data_set_id, input, options \\ [])

View Source

Updates a dataset.

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

Link to this function

update_data_set_permissions(client, aws_account_id, data_set_id, input, options \\ [])

View Source

Updates the permissions on a dataset.

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

Link to this function

update_data_source(client, aws_account_id, data_source_id, input, options \\ [])

View Source

Updates a data source.

Link to this function

update_data_source_permissions(client, aws_account_id, data_source_id, input, options \\ [])

View Source

Updates the permissions to a data source.

Link to this function

update_folder(client, aws_account_id, folder_id, input, options \\ [])

View Source

Updates the name of a folder.

Link to this function

update_folder_permissions(client, aws_account_id, folder_id, input, options \\ [])

View Source

Updates permissions of a folder.

Link to this function

update_group(client, aws_account_id, group_name, namespace, input, options \\ [])

View Source

Changes a group description.

Link to this function

update_iam_policy_assignment( client, assignment_name, aws_account_id, namespace, input, options \\ [] )

View Source

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 to this function

update_ip_restriction(client, aws_account_id, input, options \\ [])

View Source

Updates the content and status of IP rules.

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

Link to this function

update_public_sharing_settings(client, aws_account_id, input, options \\ [])

View Source

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

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

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

Link to this function

update_template(client, aws_account_id, template_id, input, options \\ [])

View Source

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

Link to this function

update_template_alias(client, alias_name, aws_account_id, template_id, input, options \\ [])

View Source

Updates the template alias of a template.

Link to this function

update_template_permissions(client, aws_account_id, template_id, input, options \\ [])

View Source

Updates the resource permissions for a template.

Link to this function

update_theme(client, aws_account_id, theme_id, input, options \\ [])

View Source

Updates a theme.

Link to this function

update_theme_alias(client, alias_name, aws_account_id, theme_id, input, options \\ [])

View Source

Updates an alias of a theme.

Link to this function

update_theme_permissions(client, aws_account_id, theme_id, input, options \\ [])

View Source

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.

Link to this function

update_user(client, aws_account_id, namespace, user_name, input, options \\ [])

View Source

Updates an Amazon QuickSight user.