View Source AWS.QuickSight (aws-elixir v1.0.4)

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

batch_create_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

Creates new reviewed answers for a Q Topic.

batch_delete_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

Deletes reviewed answers for Q Topic.

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

Cancels an ongoing ingestion of data into SPICE.

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

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

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

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

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

Creates an analysis in Amazon QuickSight.

create_brand(client, aws_account_id, brand_id, input, options \\ [])

Creates an Amazon QuickSight brand.

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

Creates a custom permissions profile.

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

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

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

Creates a dataset.

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

Creates a data source.

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

Creates an empty shared folder.

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

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

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

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

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

Adds an Amazon QuickSight user to an Amazon QuickSight group.

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

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

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

Creates and starts a new SPICE ingestion for a dataset.

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

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

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

Creates a refresh schedule for a dataset.

create_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

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

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

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

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

Creates a template alias for a template.

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

Creates a theme.

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

Creates a theme alias for a theme.

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

Creates a new Q topic.

create_topic_refresh_schedule(client, aws_account_id, topic_id, input, options \\ [])

Creates a topic refresh schedule.

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

Creates a new VPC connection.

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

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

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

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account.

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

Deletes an analysis from Amazon QuickSight.

delete_brand(client, aws_account_id, brand_id, input, options \\ [])

Deletes an Amazon QuickSight brand.

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

Deletes a brand assignment.

delete_custom_permissions(client, aws_account_id, custom_permissions_name, input, options \\ [])

Deletes a custom permissions profile.

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

Deletes a dashboard.

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

Deletes a dataset.

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

Deletes the dataset refresh properties of the dataset.

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

Deletes the data source permanently.

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

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

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

Deletes an empty folder.

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

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

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

Removes a user group from Amazon QuickSight.

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

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

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

Deletes an existing IAM policy assignment.

delete_identity_propagation_config(client, aws_account_id, service, input, options \\ [])

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

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

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

delete_refresh_schedule(client, aws_account_id, data_set_id, schedule_id, input, options \\ [])

Deletes a refresh schedule from a dataset.

delete_role_custom_permission(client, aws_account_id, namespace, role, input, options \\ [])

Removes custom permissions from the role.

delete_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

Removes a group from a role.

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

Deletes a template.

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

Deletes the item that the specified template alias points to.

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

Deletes a theme.

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

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

delete_topic(client, aws_account_id, topic_id, input, options \\ [])

Deletes a topic.

delete_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, input, options \\ [])

Deletes a topic refresh schedule.

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

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

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

Deletes a user identified by its principal ID.

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

Deletes a custom permissions profile from a user.

delete_vpc_connection(client, aws_account_id, vpc_connection_id, input, options \\ [])

Deletes a VPC connection.

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

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.

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

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

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

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

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

Provides a summary of the metadata for an analysis.

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

Provides a detailed description of the definition of an analysis.

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

Provides the read and write permissions for an analysis.

describe_asset_bundle_export_job(client, asset_bundle_export_job_id, aws_account_id, options \\ [])

Describes an existing export job.

describe_asset_bundle_import_job(client, asset_bundle_import_job_id, aws_account_id, options \\ [])

Describes an existing import job.

describe_brand(client, aws_account_id, brand_id, version_id \\ nil, options \\ [])

Describes a brand.

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

Describes a brand assignment.

describe_brand_published_version(client, aws_account_id, brand_id, options \\ [])

Describes the published version of the brand.

describe_custom_permissions(client, aws_account_id, custom_permissions_name, options \\ [])

Describes a custom permissions profile.

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

Provides a summary for a dashboard.

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

Provides a detailed description of the definition of a dashboard.

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

Describes read and write permissions for a dashboard.

describe_dashboard_snapshot_job(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

Describes an existing snapshot job.

describe_dashboard_snapshot_job_result(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

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

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

Describes an existing dashboard QA configuration.

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

Describes a dataset.

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

Describes the permissions on a dataset.

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

Describes the refresh properties of a dataset.

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

Describes a data source.

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

Describes the resource permissions for a data source.

describe_default_q_business_application(client, aws_account_id, namespace \\ nil, options \\ [])

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

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

Describes a folder.

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

Describes permissions for a folder.

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

Describes the folder resolved permissions.

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

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

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

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

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

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

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

Describes a SPICE ingestion.

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

Provides a summary and status of IP rules.

describe_key_registration(client, aws_account_id, default_key_only \\ nil, options \\ [])

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

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

Describes the current namespace.

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

Describes a personalization configuration.

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

Describes the state of a Amazon QuickSight Q Search configuration.

describe_refresh_schedule(client, aws_account_id, data_set_id, schedule_id, options \\ [])

Provides a summary of a refresh schedule.

describe_role_custom_permission(client, aws_account_id, namespace, role, options \\ [])

Describes all custom permissions that are mapped to a role.

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

Describes a template's metadata.

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

Describes the template alias for a template.

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

Provides a detailed description of the definition of a template.

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

Describes read and write permissions on a template.

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

Describes a theme.

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

Describes the alias for a theme.

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

Describes the read and write permissions for a theme.

describe_topic(client, aws_account_id, topic_id, options \\ [])

Describes a topic.

describe_topic_permissions(client, aws_account_id, topic_id, options \\ [])

Describes the permissions of a topic.

describe_topic_refresh(client, aws_account_id, refresh_id, topic_id, options \\ [])

Describes the status of a topic refresh.

describe_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, options \\ [])

Deletes a topic refresh schedule.

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

Returns information about a user, given the user name.

describe_vpc_connection(client, aws_account_id, vpc_connection_id, options \\ [])

Describes a VPC connection.

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

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.

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

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

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

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

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 \\ [])

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.

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

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

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

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

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

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

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

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

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

Lists all brands in an Amazon QuickSight account.

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

Returns a list of all the custom permissions profiles.

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

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

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

Lists dashboards in an Amazon Web Services account.

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

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

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

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

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

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

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

Lists all folders in an account.

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

List all folders that a resource is a member of.

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

Lists member users in a group.

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

Lists all user groups in Amazon QuickSight.

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

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

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

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.

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

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

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

Lists the history of SPICE ingestions for a dataset.

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

Lists the namespaces for the specified Amazon Web Services account.

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

Lists the refresh schedules of a dataset.

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

Lists all groups that are associated with a role.

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

Lists the tags assigned to a resource.

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

Lists all the aliases of a template.

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

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

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

Lists all the templates in the current Amazon QuickSight account.

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

Lists all the aliases of a theme.

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

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

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

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

list_topic_refresh_schedules(client, aws_account_id, topic_id, options \\ [])

Lists all of the refresh schedules for a topic.

list_topic_reviewed_answers(client, aws_account_id, topic_id, options \\ [])

Lists all reviewed answers for a Q Topic.

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

Lists all of the topics within an account.

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

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

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

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

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

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

metadata()

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

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

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

Creates or updates the dataset refresh properties for the dataset.

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

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

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

Restores an analysis.

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

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

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

Searches for dashboards that belong to a user.

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

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

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

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

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

Searches the subfolders in a folder.

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

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

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

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

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

Starts an Asset Bundle export job.

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

Starts an Asset Bundle import job.

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

Starts an asynchronous job that generates a snapshot of a dashboard's output.

start_dashboard_snapshot_job_schedule(client, aws_account_id, dashboard_id, schedule_id, input, options \\ [])

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

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

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

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

Removes a tag or tags from a resource.

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

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

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

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

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

Updates an analysis in Amazon QuickSight

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

Updates the read and write permissions for an analysis.

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

Updates an Amazon QuickSight application with a token exchange grant.

update_brand(client, aws_account_id, brand_id, input, options \\ [])

Updates a brand.

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

Updates a brand assignment.

update_brand_published_version(client, aws_account_id, brand_id, input, options \\ [])

Updates the published version of a brand.

update_custom_permissions(client, aws_account_id, custom_permissions_name, input, options \\ [])

Updates a custom permissions profile.

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

Updates a dashboard in an Amazon Web Services account.

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

Updates the linked analyses on a dashboard.

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

Updates read and write permissions on a dashboard.

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

Updates the published version of a dashboard.

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

Updates a Dashboard QA configuration.

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

Updates a dataset.

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

Updates the permissions on a dataset.

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

Updates a data source.

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

Updates the permissions to a data source.

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

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

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

Updates the name of a folder.

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

Updates permissions of a folder.

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

Changes a group description.

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

Updates an existing IAM policy assignment.

update_identity_propagation_config(client, aws_account_id, service, input, options \\ [])

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

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

Updates the content and status of IP rules.

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

Updates a customer managed key in a Amazon QuickSight account.

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

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

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

Updates a personalization configuration.

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

Updates the state of a Amazon QuickSight Q Search configuration.

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

Updates a refresh schedule for a dataset.

update_role_custom_permission(client, aws_account_id, namespace, role, input, options \\ [])

Updates the custom permissions that are associated with a role.

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

Updates the SPICE capacity configuration for a Amazon QuickSight account.

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

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

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

Updates the template alias of a template.

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

Updates the resource permissions for a template.

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

Updates a theme.

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

Updates an alias of a theme.

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

Updates the resource permissions for a theme.

update_topic(client, aws_account_id, topic_id, input, options \\ [])

Updates a topic.

update_topic_permissions(client, aws_account_id, topic_id, input, options \\ [])

Updates the permissions of a topic.

update_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, input, options \\ [])

Updates a topic refresh schedule.

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

Updates an Amazon QuickSight user.

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

Updates a custom permissions profile for a user.

update_vpc_connection(client, aws_account_id, vpc_connection_id, input, options \\ [])

Updates a VPC connection.

Link to this section Functions

batch_create_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

Creates new reviewed answers for a Q Topic.

batch_delete_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

Deletes reviewed answers for Q Topic.

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

Cancels an ongoing ingestion of data into SPICE.

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

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


API operation.

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

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

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

Creates an analysis in Amazon QuickSight.

Analyses can be created either from a template or from an AnalysisDefinition.

create_brand(client, aws_account_id, brand_id, input, options \\ [])

Creates an Amazon QuickSight brand.

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

Creates a custom permissions profile.

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

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.

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.

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

Creates a dataset.

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

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

Creates a data source.

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

Creates an empty shared folder.

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

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

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

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::## :group/default/

The response is a group object.

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

Adds an Amazon QuickSight user to an Amazon QuickSight group.

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

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.

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

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.

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

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

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

Creates a refresh schedule for a dataset.

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

create_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

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

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

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

You can use the resulting template to create additional dashboards, templates, or analyses.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

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

Creates a template alias for a template.

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

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.

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

Creates a theme alias for a theme.

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

Creates a new Q topic.

create_topic_refresh_schedule(client, aws_account_id, topic_id, input, options \\ [])

Creates a topic refresh schedule.

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

Creates a new VPC connection.

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

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

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

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.

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

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.

delete_brand(client, aws_account_id, brand_id, input, options \\ [])

Deletes an Amazon QuickSight brand.

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

Deletes a brand assignment.

delete_custom_permissions(client, aws_account_id, custom_permissions_name, input, options \\ [])

Deletes a custom permissions profile.

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

Deletes a dashboard.

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

Deletes a dataset.

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

Deletes the dataset refresh properties of the dataset.

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

Deletes the data source permanently.

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

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

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

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

Deletes an empty folder.

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

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

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

Removes a user group from Amazon QuickSight.

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

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

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

Deletes an existing IAM policy assignment.

delete_identity_propagation_config(client, aws_account_id, service, input, options \\ [])

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.

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

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.

delete_refresh_schedule(client, aws_account_id, data_set_id, schedule_id, input, options \\ [])

Deletes a refresh schedule from a dataset.

delete_role_custom_permission(client, aws_account_id, namespace, role, input, options \\ [])

Removes custom permissions from the role.

delete_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

Removes a group from a role.

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

Deletes a template.

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

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.

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

Deletes a theme.

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

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.

delete_topic(client, aws_account_id, topic_id, input, options \\ [])

Deletes a topic.

delete_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, input, options \\ [])

Deletes a topic refresh schedule.

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

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.

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

Deletes a user identified by its principal ID.

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

Deletes a custom permissions profile from a user.

delete_vpc_connection(client, aws_account_id, vpc_connection_id, input, options \\ [])

Deletes a VPC connection.

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

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.

Use named profiles.

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.

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

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

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

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.

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

Provides a summary of the metadata for an analysis.

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

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

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

Provides the read and write permissions for an analysis.

describe_asset_bundle_export_job(client, asset_bundle_export_job_id, aws_account_id, options \\ [])

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.

Job descriptions are available for 14 days after the job starts.

describe_asset_bundle_import_job(client, asset_bundle_import_job_id, aws_account_id, options \\ [])

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.

describe_brand(client, aws_account_id, brand_id, version_id \\ nil, options \\ [])

Describes a brand.

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

Describes a brand assignment.

describe_brand_published_version(client, aws_account_id, brand_id, options \\ [])

Describes the published version of the brand.

describe_custom_permissions(client, aws_account_id, custom_permissions_name, options \\ [])

Describes a custom permissions profile.

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

Provides a summary for a dashboard.

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

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

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

Describes read and write permissions for a dashboard.

describe_dashboard_snapshot_job(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

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

describe_dashboard_snapshot_job_result(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

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.

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

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

Describes an existing dashboard QA configuration.

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

Describes a dataset.

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

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

Describes the permissions on a dataset.

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

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

Describes the refresh properties of a dataset.

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

Describes a data source.

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

Describes the resource permissions for a data source.

describe_default_q_business_application(client, aws_account_id, namespace \\ nil, options \\ [])

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

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

Describes a folder.

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

Describes permissions for a folder.

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

Describes the folder resolved permissions.

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

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

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

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

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.

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

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

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

Describes a SPICE ingestion.

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

Provides a summary and status of IP rules.

describe_key_registration(client, aws_account_id, default_key_only \\ nil, options \\ [])

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

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

Describes the current namespace.

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

Describes a personalization configuration.

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

Describes the state of a Amazon QuickSight Q Search configuration.

describe_refresh_schedule(client, aws_account_id, data_set_id, schedule_id, options \\ [])

Provides a summary of a refresh schedule.

describe_role_custom_permission(client, aws_account_id, namespace, role, options \\ [])

Describes all custom permissions that are mapped to a role.

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

Describes a template's metadata.

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

Describes the template alias for a template.

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

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

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

Describes read and write permissions on a template.

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

Describes a theme.

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

Describes the alias for a theme.

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

Describes the read and write permissions for a theme.

describe_topic(client, aws_account_id, topic_id, options \\ [])

Describes a topic.

describe_topic_permissions(client, aws_account_id, topic_id, options \\ [])

Describes the permissions of a topic.

describe_topic_refresh(client, aws_account_id, refresh_id, topic_id, options \\ [])

Describes the status of a topic refresh.

describe_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, options \\ [])

Deletes a topic refresh schedule.

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

Returns information about a user, given the user name.

describe_vpc_connection(client, aws_account_id, vpc_connection_id, options \\ [])

Describes a VPC connection.

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

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

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](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).

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

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

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](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html).

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

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.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

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 \\ [])

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.

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

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


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)

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

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

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

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.

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

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.

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

Lists all brands in an Amazon QuickSight account.

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

Returns a list of all the custom permissions profiles.

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

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

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

Lists dashboards in an Amazon Web Services account.

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

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

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

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

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

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

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

Lists all folders in an account.

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

List all folders that a resource is a member of.

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

Lists member users in a group.

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

Lists all user groups in Amazon QuickSight.

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

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

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

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.

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

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

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

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

Lists the history of SPICE ingestions for a dataset.

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

Lists the namespaces for the specified Amazon Web Services account.

This operation doesn't list deleted namespaces.

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

Lists the refresh schedules of a dataset.

Each dataset can have up to 5 schedules.

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

Lists all groups that are associated with a role.

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

Lists the tags assigned to a resource.

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

Lists all the aliases of a template.

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

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

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

Lists all the templates in the current Amazon QuickSight account.

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

Lists all the aliases of a theme.

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

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

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

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

list_topic_refresh_schedules(client, aws_account_id, topic_id, options \\ [])

Lists all of the refresh schedules for a topic.

list_topic_reviewed_answers(client, aws_account_id, topic_id, options \\ [])

Lists all reviewed answers for a Q Topic.

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

Lists all of the topics within an account.

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

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

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

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

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

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

metadata()

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

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

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

Creates or updates the dataset refresh properties for the dataset.

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

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.

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

Restores an analysis.

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

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.

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

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.

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

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

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

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

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

Searches the subfolders in a folder.

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

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

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

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

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

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.

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

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

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.

The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

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

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.

* 1 Paginated PDF

* 1 Excel workbook that includes up to 5 table or pivot table visuals

* 5 CSVs from table or pivot table visuals

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

startdashboardsnapshotjob-api-throttling
StartDashboardSnapshotJob API throttling

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

common-throttling-scenarios
Common throttling scenarios

The following list provides information about the most commin throttling scenarios that can occur.

A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.

A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned.

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

best-practices-to-handle-throttling
Best practices to handle throttling

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

The time that it takes to process a job can be impacted by the following factors:

* The dataset type (Direct Query or SPICE).

* The size of the dataset.

* The complexity of the calculated fields that are used in the dashboard.

* The number of visuals that are on a sheet.

* The types of visuals that are on the sheet.

* The number of formats and snapshots that are requested in the job configuration.

* The size of the generated snapshots.

start_dashboard_snapshot_job_schedule(client, aws_account_id, dashboard_id, schedule_id, input, options \\ [])

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

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.

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

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.

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

Removes a tag or tags from a resource.

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

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.

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

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

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

Updates an analysis in Amazon QuickSight

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

Updates the read and write permissions for an analysis.

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

Updates an Amazon QuickSight application with a token exchange grant.

This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.

update_brand(client, aws_account_id, brand_id, input, options \\ [])

Updates a brand.

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

Updates a brand assignment.

update_brand_published_version(client, aws_account_id, brand_id, input, options \\ [])

Updates the published version of a brand.

update_custom_permissions(client, aws_account_id, custom_permissions_name, input, options \\ [])

Updates a custom permissions profile.

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

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.

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

Updates the linked analyses on a dashboard.

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

Updates read and write permissions on a dashboard.

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

Updates the published version of a dashboard.

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

Updates a Dashboard QA configuration.

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

Updates a dataset.

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

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

Updates the permissions on a dataset.

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

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

Updates a data source.

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

Updates the permissions to a data source.

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

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

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

Updates the name of a folder.

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

Updates permissions of a folder.

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

Changes a group description.

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

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.

update_identity_propagation_config(client, aws_account_id, service, input, options \\ [])

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

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

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

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.

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

Updates a customer managed key in a Amazon QuickSight account.

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

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.

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

Updates a personalization configuration.

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

Updates the state of a Amazon QuickSight Q Search configuration.

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

Updates a refresh schedule for a dataset.

update_role_custom_permission(client, aws_account_id, namespace, role, input, options \\ [])

Updates the custom permissions that are associated with a role.

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

Updates the SPICE capacity configuration for a Amazon QuickSight account.

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

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

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

Updates the template alias of a template.

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

Updates the resource permissions for a template.

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

Updates a theme.

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

Updates an alias of a theme.

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

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.

update_topic(client, aws_account_id, topic_id, input, options \\ [])

Updates a topic.

update_topic_permissions(client, aws_account_id, topic_id, input, options \\ [])

Updates the permissions of a topic.

update_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, input, options \\ [])

Updates a topic refresh schedule.

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

Updates an Amazon QuickSight user.

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

Updates a custom permissions profile for a user.

update_vpc_connection(client, aws_account_id, vpc_connection_id, input, options \\ [])

Updates a VPC connection.

Settings View Source AWS.QuickSight (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

batch_create_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

batch_delete_topic_reviewed_answer(client, aws_account_id, topic_id, input, options \\ [])

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

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

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

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

create_brand(client, aws_account_id, brand_id, input, options \\ [])

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

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

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

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

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

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

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

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

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

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

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

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

create_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

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

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

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

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

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

create_topic_refresh_schedule(client, aws_account_id, topic_id, input, options \\ [])

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

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

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

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

delete_brand(client, aws_account_id, brand_id, input, options \\ [])

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

delete_custom_permissions(client, aws_account_id, custom_permissions_name, input, options \\ [])

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

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

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

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

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

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

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

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

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

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

delete_identity_propagation_config(client, aws_account_id, service, input, options \\ [])

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

delete_refresh_schedule(client, aws_account_id, data_set_id, schedule_id, input, options \\ [])

delete_role_custom_permission(client, aws_account_id, namespace, role, input, options \\ [])

delete_role_membership(client, aws_account_id, member_name, namespace, role, input, options \\ [])

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

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

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

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

delete_topic(client, aws_account_id, topic_id, input, options \\ [])

delete_topic_refresh_schedule(client, aws_account_id, dataset_id, topic_id, input, options \\ [])

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

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

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

delete_vpc_connection(client, aws_account_id, vpc_connection_id, input, options \\ [])

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

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

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

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

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

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

describe_asset_bundle_export_job(client, asset_bundle_export_job_id, aws_account_id, options \\ [])

describe_asset_bundle_import_job(client, asset_bundle_import_job_id, aws_account_id, options \\ [])

describe_brand(client, aws_account_id, brand_id, version_id \\ nil, options \\ [])

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

describe_brand_published_version(client, aws_account_id, brand_id, options \\ [])

describe_custom_permissions(client, aws_account_id, custom_permissions_name, options \\ [])

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

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

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

describe_dashboard_snapshot_job(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

describe_dashboard_snapshot_job_result(client, aws_account_id, dashboard_id, snapshot_job_id, options \\ [])

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

View Source AWS.QuickSight (aws-elixir v1.0.4)