R/quicksight_service.R

Defines functions service quicksight

Documented in quicksight

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config merge_config
NULL

#' Amazon QuickSight
#'
#' @description
#' Amazon Quick API Reference
#' 
#' Amazon Quick Sight 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 Quick Sight.
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#' \itemize{
#' \item{\strong{credentials}: \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }}
#' \item{\strong{endpoint}: The complete URL to use for the constructed client.}
#' \item{\strong{region}: The AWS Region used in instantiating the client.}
#' \item{\strong{close_connection}: Immediately close all HTTP connections.}
#' \item{\strong{timeout}: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.}
#' \item{\strong{s3_force_path_style}: Set this to `true` to force the request to use path-style addressing, i.e. `http://s3.amazonaws.com/BUCKET/KEY`.}
#' \item{\strong{sts_regional_endpoint}: Set sts regional endpoint resolver to regional or legacy \url{https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html}}
#' \item{\strong{use_dual_stack}: Set this to `true` to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the `AWS_USE_DUALSTACK_ENDPOINT` environment variable when unset.}
#' }
#' @param
#' credentials
#' Optional credentials shorthand for the config parameter
#' \itemize{
#' \item{\strong{creds}: \itemize{
#' \item{\strong{access_key_id}: AWS access key ID}
#' \item{\strong{secret_access_key}: AWS secret access key}
#' \item{\strong{session_token}: AWS temporary session token}
#' }}
#' \item{\strong{profile}: The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}: Set anonymous credentials.}
#' }
#' @param
#' endpoint
#' Optional shorthand for complete URL to use for the constructed client.
#' @param
#' region
#' Optional shorthand for AWS Region used in instantiating the client.
#'
#' @section Service syntax:
#' ```
#' svc <- quicksight(
#'   config = list(
#'     credentials = list(
#'       creds = list(
#'         access_key_id = "string",
#'         secret_access_key = "string",
#'         session_token = "string"
#'       ),
#'       profile = "string",
#'       anonymous = "logical"
#'     ),
#'     endpoint = "string",
#'     region = "string",
#'     close_connection = "logical",
#'     timeout = "numeric",
#'     s3_force_path_style = "logical",
#'     sts_regional_endpoint = "string",
#'     use_dual_stack = "logical"
#'   ),
#'   credentials = list(
#'     creds = list(
#'       access_key_id = "string",
#'       secret_access_key = "string",
#'       session_token = "string"
#'     ),
#'     profile = "string",
#'     anonymous = "logical"
#'   ),
#'   endpoint = "string",
#'   region = "string"
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- quicksight()
#' svc$batch_create_topic_reviewed_answer(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=quicksight_batch_create_topic_reviewed_answer]{batch_create_topic_reviewed_answer} \tab Creates new reviewed answers for a Q Topic\cr
#'  \link[=quicksight_batch_delete_knowledge_base]{batch_delete_knowledge_base} \tab Deletes one or more knowledge bases\cr
#'  \link[=quicksight_batch_delete_topic_reviewed_answer]{batch_delete_topic_reviewed_answer} \tab Deletes reviewed answers for Q Topic\cr
#'  \link[=quicksight_batch_describe_user_limits]{batch_describe_user_limits} \tab Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments\cr
#'  \link[=quicksight_cancel_ingestion]{cancel_ingestion} \tab Cancels an ongoing ingestion of data into SPICE\cr
#'  \link[=quicksight_create_account_customization]{create_account_customization} \tab Creates Amazon Quick Sight customizations\cr
#'  \link[=quicksight_create_account_subscription]{create_account_subscription} \tab Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q\cr
#'  \link[=quicksight_create_action_connector]{create_action_connector} \tab Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions\cr
#'  \link[=quicksight_create_agent]{create_agent} \tab Creates an agent in Amazon QuickSight\cr
#'  \link[=quicksight_create_analysis]{create_analysis} \tab Creates an analysis in Amazon Quick Sight\cr
#'  \link[=quicksight_create_approval_policy]{create_approval_policy} \tab Creates an approval policy in Quick Sight\cr
#'  \link[=quicksight_create_brand]{create_brand} \tab Creates an Quick Sight brand\cr
#'  \link[=quicksight_create_custom_permissions]{create_custom_permissions} \tab Creates a custom permissions profile\cr
#'  \link[=quicksight_create_dashboard]{create_dashboard} \tab Creates a dashboard from either a template or directly with a DashboardDefinition\cr
#'  \link[=quicksight_create_data_set]{create_data_set} \tab Creates a dataset\cr
#'  \link[=quicksight_create_data_source]{create_data_source} \tab Creates a data source\cr
#'  \link[=quicksight_create_dlp_setting]{create_dlp_setting} \tab Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account\cr
#'  \link[=quicksight_create_flow]{create_flow} \tab Creates a new flow in the specified Amazon Web Services account\cr
#'  \link[=quicksight_create_folder]{create_folder} \tab Creates an empty shared folder\cr
#'  \link[=quicksight_create_folder_membership]{create_folder_membership} \tab Adds an asset, such as a dashboard, analysis, or dataset into a folder\cr
#'  \link[=quicksight_create_group]{create_group} \tab Use the CreateGroup operation to create a group in Quick Sight\cr
#'  \link[=quicksight_create_group_membership]{create_group_membership} \tab Adds an Amazon Quick Sight user to an Amazon Quick Sight group\cr
#'  \link[=quicksight_create_iam_policy_assignment]{create_iam_policy_assignment} \tab Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN)\cr
#'  \link[=quicksight_create_ingestion]{create_ingestion} \tab Creates and starts a new SPICE ingestion for a dataset\cr
#'  \link[=quicksight_create_knowledge_base]{create_knowledge_base} \tab Creates a knowledge base from a specified data source\cr
#'  \link[=quicksight_create_limits_profile]{create_limits_profile} \tab Creates a limits profile that defines resource usage limits for Amazon Quick Sight users\cr
#'  \link[=quicksight_create_namespace]{create_namespace} \tab (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight\cr
#'  \link[=quicksight_create_o_auth_client_application]{create_o_auth_client_application} \tab Creates an OAuthClientApplication\cr
#'  \link[=quicksight_create_refresh_schedule]{create_refresh_schedule} \tab Creates a refresh schedule for a dataset\cr
#'  \link[=quicksight_create_role_membership]{create_role_membership} \tab Use CreateRoleMembership to add an existing Quick Sight group to an existing role\cr
#'  \link[=quicksight_create_space]{create_space} \tab Creates a new Amazon QuickSight space\cr
#'  \link[=quicksight_create_template]{create_template} \tab Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template\cr
#'  \link[=quicksight_create_template_alias]{create_template_alias} \tab Creates a template alias for a template\cr
#'  \link[=quicksight_create_theme]{create_theme} \tab Creates a theme\cr
#'  \link[=quicksight_create_theme_alias]{create_theme_alias} \tab Creates a theme alias for a theme\cr
#'  \link[=quicksight_create_topic]{create_topic} \tab Creates a new Q topic\cr
#'  \link[=quicksight_create_topic_refresh_schedule]{create_topic_refresh_schedule} \tab Creates a topic refresh schedule\cr
#'  \link[=quicksight_create_topic_v2]{create_topic_v2} \tab Creates a new Q topic\cr
#'  \link[=quicksight_create_vpc_connection]{create_vpc_connection} \tab Creates a new VPC connection\cr
#'  \link[=quicksight_delete_account_customization]{delete_account_customization} \tab This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace\cr
#'  \link[=quicksight_delete_account_custom_permission]{delete_account_custom_permission} \tab Unapplies a custom permissions profile from an account\cr
#'  \link[=quicksight_delete_account_subscription]{delete_account_subscription} \tab Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:\cr
#'  \link[=quicksight_delete_action_connector]{delete_action_connector} \tab Hard deletes an action connector, making it unrecoverable\cr
#'  \link[=quicksight_delete_agent]{delete_agent} \tab Deletes an agent\cr
#'  \link[=quicksight_delete_analysis]{delete_analysis} \tab Deletes an analysis from Amazon Quick Sight\cr
#'  \link[=quicksight_delete_app]{delete_app} \tab Deletes an app\cr
#'  \link[=quicksight_delete_approval_policy]{delete_approval_policy} \tab Deletes an approval policy in Quick Sight\cr
#'  \link[=quicksight_delete_brand]{delete_brand} \tab This API permanently deletes the specified Quick Sight brand\cr
#'  \link[=quicksight_delete_brand_assignment]{delete_brand_assignment} \tab Deletes a brand assignment\cr
#'  \link[=quicksight_delete_custom_permissions]{delete_custom_permissions} \tab Deletes a custom permissions profile\cr
#'  \link[=quicksight_delete_dashboard]{delete_dashboard} \tab Deletes a dashboard\cr
#'  \link[=quicksight_delete_data_set]{delete_data_set} \tab Deletes a dataset\cr
#'  \link[=quicksight_delete_data_set_refresh_properties]{delete_data_set_refresh_properties} \tab Deletes the dataset refresh properties of the dataset\cr
#'  \link[=quicksight_delete_data_source]{delete_data_source} \tab Deletes the data source permanently\cr
#'  \link[=quicksight_delete_default_q_business_application]{delete_default_q_business_application} \tab Deletes a linked Amazon Q Business application from an Quick Sight account\cr
#'  \link[=quicksight_delete_dlp_setting]{delete_dlp_setting} \tab Deletes a DLP setting configuration from an Amazon Web Services account\cr
#'  \link[=quicksight_delete_flow]{delete_flow} \tab Permanently deletes a flow from the specified Amazon Web Services account\cr
#'  \link[=quicksight_delete_folder]{delete_folder} \tab Deletes an empty folder\cr
#'  \link[=quicksight_delete_folder_membership]{delete_folder_membership} \tab Removes an asset, such as a dashboard, analysis, or dataset, from a folder\cr
#'  \link[=quicksight_delete_group]{delete_group} \tab Removes a user group from Amazon Quick Sight\cr
#'  \link[=quicksight_delete_group_membership]{delete_group_membership} \tab Removes a user from a group so that the user is no longer a member of the group\cr
#'  \link[=quicksight_delete_iam_policy_assignment]{delete_iam_policy_assignment} \tab Deletes an existing IAM policy assignment\cr
#'  \link[=quicksight_delete_identity_propagation_config]{delete_identity_propagation_config} \tab Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application\cr
#'  \link[=quicksight_delete_knowledge_base]{delete_knowledge_base} \tab Deletes a knowledge base\cr
#'  \link[=quicksight_delete_limits_profile]{delete_limits_profile} \tab Deletes a limits profile\cr
#'  \link[=quicksight_delete_namespace]{delete_namespace} \tab Deletes a namespace and the users and groups that are associated with the namespace\cr
#'  \link[=quicksight_delete_o_auth_client_application]{delete_o_auth_client_application} \tab Deletes an OAuthClientApplication\cr
#'  \link[=quicksight_delete_refresh_schedule]{delete_refresh_schedule} \tab Deletes a refresh schedule from a dataset\cr
#'  \link[=quicksight_delete_role_custom_permission]{delete_role_custom_permission} \tab Removes custom permissions from the role\cr
#'  \link[=quicksight_delete_role_membership]{delete_role_membership} \tab Removes a group from a role\cr
#'  \link[=quicksight_delete_space]{delete_space} \tab Deletes an Amazon QuickSight space\cr
#'  \link[=quicksight_delete_template]{delete_template} \tab Deletes a template\cr
#'  \link[=quicksight_delete_template_alias]{delete_template_alias} \tab Deletes the item that the specified template alias points to\cr
#'  \link[=quicksight_delete_theme]{delete_theme} \tab Deletes a theme\cr
#'  \link[=quicksight_delete_theme_alias]{delete_theme_alias} \tab Deletes the version of the theme that the specified theme alias points to\cr
#'  \link[=quicksight_delete_topic]{delete_topic} \tab Deletes a topic\cr
#'  \link[=quicksight_delete_topic_refresh_schedule]{delete_topic_refresh_schedule} \tab Deletes a topic refresh schedule\cr
#'  \link[=quicksight_delete_topic_v2]{delete_topic_v2} \tab Deletes a Q topic\cr
#'  \link[=quicksight_delete_user]{delete_user} \tab Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call\cr
#'  \link[=quicksight_delete_user_by_principal_id]{delete_user_by_principal_id} \tab Deletes a user identified by its principal ID\cr
#'  \link[=quicksight_delete_user_custom_permission]{delete_user_custom_permission} \tab Deletes a custom permissions profile from a user\cr
#'  \link[=quicksight_delete_vpc_connection]{delete_vpc_connection} \tab Deletes a VPC connection\cr
#'  \link[=quicksight_describe_account_customization]{describe_account_customization} \tab Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace\cr
#'  \link[=quicksight_describe_account_custom_permission]{describe_account_custom_permission} \tab Describes the custom permissions profile that is applied to an account\cr
#'  \link[=quicksight_describe_account_settings]{describe_account_settings} \tab Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account\cr
#'  \link[=quicksight_describe_account_subscription]{describe_account_subscription} \tab Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription\cr
#'  \link[=quicksight_describe_action_connector]{describe_action_connector} \tab Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status\cr
#'  \link[=quicksight_describe_action_connector_permissions]{describe_action_connector_permissions} \tab Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform\cr
#'  \link[=quicksight_describe_agent]{describe_agent} \tab Describes an agent\cr
#'  \link[=quicksight_describe_agent_permissions]{describe_agent_permissions} \tab Describes the resource permissions for an agent\cr
#'  \link[=quicksight_describe_analysis]{describe_analysis} \tab Provides a summary of the metadata for an analysis\cr
#'  \link[=quicksight_describe_analysis_definition]{describe_analysis_definition} \tab Provides a detailed description of the definition of an analysis\cr
#'  \link[=quicksight_describe_analysis_permissions]{describe_analysis_permissions} \tab Provides the read and write permissions for an analysis\cr
#'  \link[=quicksight_describe_app]{describe_app} \tab Describes an app\cr
#'  \link[=quicksight_describe_app_permissions]{describe_app_permissions} \tab Describes the resource permissions for an app\cr
#'  \link[=quicksight_describe_approval_policy]{describe_approval_policy} \tab Describes an approval policy in Quick Sight\cr
#'  \link[=quicksight_describe_asset_bundle_export_job]{describe_asset_bundle_export_job} \tab Describes an existing export job\cr
#'  \link[=quicksight_describe_asset_bundle_import_job]{describe_asset_bundle_import_job} \tab Describes an existing import job\cr
#'  \link[=quicksight_describe_automation_job]{describe_automation_job} \tab Retrieves the status and details of a specified automation job, including its status and outputs\cr
#'  \link[=quicksight_describe_brand]{describe_brand} \tab Describes a brand\cr
#'  \link[=quicksight_describe_brand_assignment]{describe_brand_assignment} \tab Describes a brand assignment\cr
#'  \link[=quicksight_describe_brand_published_version]{describe_brand_published_version} \tab Describes the published version of the brand\cr
#'  \link[=quicksight_describe_custom_permissions]{describe_custom_permissions} \tab Describes a custom permissions profile\cr
#'  \link[=quicksight_describe_dashboard]{describe_dashboard} \tab Provides a summary for a dashboard\cr
#'  \link[=quicksight_describe_dashboard_definition]{describe_dashboard_definition} \tab Provides a detailed description of the definition of a dashboard\cr
#'  \link[=quicksight_describe_dashboard_permissions]{describe_dashboard_permissions} \tab Describes read and write permissions for a dashboard\cr
#'  \link[=quicksight_describe_dashboard_snapshot_job]{describe_dashboard_snapshot_job} \tab Describes an existing snapshot job\cr
#'  \link[=quicksight_describe_dashboard_snapshot_job_result]{describe_dashboard_snapshot_job_result} \tab Describes the result of an existing snapshot job that has finished running\cr
#'  \link[=quicksight_describe_dashboards_qa_configuration]{describe_dashboards_qa_configuration} \tab Describes an existing dashboard QA configuration\cr
#'  \link[=quicksight_describe_data_set]{describe_data_set} \tab Describes a dataset\cr
#'  \link[=quicksight_describe_data_set_permissions]{describe_data_set_permissions} \tab Describes the permissions on a dataset\cr
#'  \link[=quicksight_describe_data_set_refresh_properties]{describe_data_set_refresh_properties} \tab Describes the refresh properties of a dataset\cr
#'  \link[=quicksight_describe_data_source]{describe_data_source} \tab Describes a data source\cr
#'  \link[=quicksight_describe_data_source_permissions]{describe_data_source_permissions} \tab Describes the resource permissions for a data source\cr
#'  \link[=quicksight_describe_default_q_business_application]{describe_default_q_business_application} \tab Describes a Amazon Q Business application that is linked to an Quick Sight account\cr
#'  \link[=quicksight_describe_dlp_setting]{describe_dlp_setting} \tab Describes the full configuration of a DLP setting in an Amazon Web Services account\cr
#'  \link[=quicksight_describe_flow]{describe_flow} \tab Returns the full details of a flow for the latest version of the requested publish state\cr
#'  \link[=quicksight_describe_folder]{describe_folder} \tab Describes a folder\cr
#'  \link[=quicksight_describe_folder_permissions]{describe_folder_permissions} \tab Describes permissions for a folder\cr
#'  \link[=quicksight_describe_folder_resolved_permissions]{describe_folder_resolved_permissions} \tab Describes the folder resolved permissions\cr
#'  \link[=quicksight_describe_group]{describe_group} \tab Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN)\cr
#'  \link[=quicksight_describe_group_membership]{describe_group_membership} \tab Use the DescribeGroupMembership operation to determine if a user is a member of the specified group\cr
#'  \link[=quicksight_describe_iam_policy_assignment]{describe_iam_policy_assignment} \tab Describes an existing IAM policy assignment, as specified by the assignment name\cr
#'  \link[=quicksight_describe_ingestion]{describe_ingestion} \tab Describes a SPICE ingestion\cr
#'  \link[=quicksight_describe_ip_restriction]{describe_ip_restriction} \tab Provides a summary and status of IP rules\cr
#'  \link[=quicksight_describe_key_registration]{describe_key_registration} \tab Describes all customer managed key registrations in a Quick Sight account\cr
#'  \link[=quicksight_describe_knowledge_base]{describe_knowledge_base} \tab Describes a knowledge base\cr
#'  \link[=quicksight_describe_knowledge_base_permissions]{describe_knowledge_base_permissions} \tab Describes the resource permissions for a knowledge base\cr
#'  \link[=quicksight_describe_limits_profile]{describe_limits_profile} \tab Describes the properties of an existing limits profile\cr
#'  \link[=quicksight_describe_namespace]{describe_namespace} \tab Describes the current namespace\cr
#'  \link[=quicksight_describe_o_auth_client_application]{describe_o_auth_client_application} \tab Describes an OAuthClientApplication\cr
#'  \link[=quicksight_describe_q_personalization_configuration]{describe_q_personalization_configuration} \tab Describes a personalization configuration\cr
#'  \link[=quicksight_describe_quick_sight_q_search_configuration]{describe_quick_sight_q_search_configuration} \tab Describes the state of a Quick Sight Q Search configuration\cr
#'  \link[=quicksight_describe_refresh_schedule]{describe_refresh_schedule} \tab Provides a summary of a refresh schedule\cr
#'  \link[=quicksight_describe_role_custom_permission]{describe_role_custom_permission} \tab Describes all custom permissions that are mapped to a role\cr
#'  \link[=quicksight_describe_self_upgrade_configuration]{describe_self_upgrade_configuration} \tab Describes the self-upgrade configuration for a Quick account\cr
#'  \link[=quicksight_describe_space]{describe_space} \tab Describes an Amazon QuickSight space\cr
#'  \link[=quicksight_describe_space_permissions]{describe_space_permissions} \tab Describes the permissions for an Amazon QuickSight space\cr
#'  \link[=quicksight_describe_template]{describe_template} \tab Describes a template's metadata\cr
#'  \link[=quicksight_describe_template_alias]{describe_template_alias} \tab Describes the template alias for a template\cr
#'  \link[=quicksight_describe_template_definition]{describe_template_definition} \tab Provides a detailed description of the definition of a template\cr
#'  \link[=quicksight_describe_template_permissions]{describe_template_permissions} \tab Describes read and write permissions on a template\cr
#'  \link[=quicksight_describe_theme]{describe_theme} \tab Describes a theme\cr
#'  \link[=quicksight_describe_theme_alias]{describe_theme_alias} \tab Describes the alias for a theme\cr
#'  \link[=quicksight_describe_theme_permissions]{describe_theme_permissions} \tab Describes the read and write permissions for a theme\cr
#'  \link[=quicksight_describe_topic]{describe_topic} \tab Describes a topic\cr
#'  \link[=quicksight_describe_topic_permissions]{describe_topic_permissions} \tab Describes the permissions of a topic\cr
#'  \link[=quicksight_describe_topic_permissions_v2]{describe_topic_permissions_v2} \tab Describes the permissions of a topic\cr
#'  \link[=quicksight_describe_topic_refresh]{describe_topic_refresh} \tab Describes the status of a topic refresh\cr
#'  \link[=quicksight_describe_topic_refresh_schedule]{describe_topic_refresh_schedule} \tab Deletes a topic refresh schedule\cr
#'  \link[=quicksight_describe_topic_v2]{describe_topic_v2} \tab Describes a Q topic\cr
#'  \link[=quicksight_describe_user]{describe_user} \tab Returns information about a user, given the user name\cr
#'  \link[=quicksight_describe_vpc_connection]{describe_vpc_connection} \tab Describes a VPC connection\cr
#'  \link[=quicksight_generate_embed_url_for_anonymous_user]{generate_embed_url_for_anonymous_user} \tab Generates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users\cr
#'  \link[=quicksight_generate_embed_url_for_registered_user]{generate_embed_url_for_registered_user} \tab Generates an embed URL that you can use to embed an Amazon Quick experience in your website\cr
#'  \link[=quicksight_generate_embed_url_for_registered_user_with_identity]{generate_embed_url_for_registered_user_with_identity} \tab Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website\cr
#'  \link[=quicksight_get_dashboard_embed_url]{get_dashboard_embed_url} \tab Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application\cr
#'  \link[=quicksight_get_flow_metadata]{get_flow_metadata} \tab Retrieves the metadata of a flow, not including its definition specifying the steps\cr
#'  \link[=quicksight_get_flow_permissions]{get_flow_permissions} \tab Get permissions for a flow\cr
#'  \link[=quicksight_get_identity_context]{get_identity_context} \tab Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs\cr
#'  \link[=quicksight_get_session_embed_url]{get_session_embed_url} \tab Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code\cr
#'  \link[=quicksight_list_action_connectors]{list_action_connectors} \tab Lists all action connectors in the specified Amazon Web Services account\cr
#'  \link[=quicksight_list_agents]{list_agents} \tab Lists all agents in an Amazon QuickSight account\cr
#'  \link[=quicksight_list_analyses]{list_analyses} \tab Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account\cr
#'  \link[=quicksight_list_approval_policies]{list_approval_policies} \tab Lists all approval policies in the specified Quick Sight account\cr
#'  \link[=quicksight_list_apps]{list_apps} \tab Lists the apps in an Amazon Web Services account\cr
#'  \link[=quicksight_list_asset_bundle_export_jobs]{list_asset_bundle_export_jobs} \tab Lists all asset bundle export jobs that have been taken place in the last 14 days\cr
#'  \link[=quicksight_list_asset_bundle_import_jobs]{list_asset_bundle_import_jobs} \tab Lists all asset bundle import jobs that have taken place in the last 14 days\cr
#'  \link[=quicksight_list_brands]{list_brands} \tab Lists all brands in an Quick Sight account\cr
#'  \link[=quicksight_list_custom_permissions]{list_custom_permissions} \tab Returns a list of all the custom permissions profiles\cr
#'  \link[=quicksight_list_dashboards]{list_dashboards} \tab Lists dashboards in an Amazon Web Services account\cr
#'  \link[=quicksight_list_dashboard_versions]{list_dashboard_versions} \tab Lists all the versions of the dashboards in the Amazon Quick Sight subscription\cr
#'  \link[=quicksight_list_data_sets]{list_data_sets} \tab Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region\cr
#'  \link[=quicksight_list_data_sources]{list_data_sources} \tab Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account\cr
#'  \link[=quicksight_list_dlp_settings]{list_dlp_settings} \tab Lists all DLP settings in an Amazon Web Services account\cr
#'  \link[=quicksight_list_flows]{list_flows} \tab Lists flows in an Amazon Web Services account\cr
#'  \link[=quicksight_list_folder_members]{list_folder_members} \tab List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder\cr
#'  \link[=quicksight_list_folders]{list_folders} \tab Lists all folders in an account\cr
#'  \link[=quicksight_list_folders_for_resource]{list_folders_for_resource} \tab List all folders that a resource is a member of\cr
#'  \link[=quicksight_list_group_memberships]{list_group_memberships} \tab Lists member users in a group\cr
#'  \link[=quicksight_list_groups]{list_groups} \tab Lists all user groups in Amazon Quick Sight\cr
#'  \link[=quicksight_list_iam_policy_assignments]{list_iam_policy_assignments} \tab Lists the IAM policy assignments in the current Amazon Quick Sight account\cr
#'  \link[=quicksight_list_iam_policy_assignments_for_user]{list_iam_policy_assignments_for_user} \tab 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\cr
#'  \link[=quicksight_list_identity_propagation_configs]{list_identity_propagation_configs} \tab Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access\cr
#'  \link[=quicksight_list_ingestions]{list_ingestions} \tab Lists the history of SPICE ingestions for a dataset\cr
#'  \link[=quicksight_list_knowledge_bases]{list_knowledge_bases} \tab Lists all knowledge bases in an Amazon QuickSight account\cr
#'  \link[=quicksight_list_limits_profiles]{list_limits_profiles} \tab Lists all limits profiles in an Amazon Quick Sight account\cr
#'  \link[=quicksight_list_namespaces]{list_namespaces} \tab Lists the namespaces for the specified Amazon Web Services account\cr
#'  \link[=quicksight_list_o_auth_client_applications]{list_o_auth_client_applications} \tab Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account\cr
#'  \link[=quicksight_list_refresh_schedules]{list_refresh_schedules} \tab Lists the refresh schedules of a dataset\cr
#'  \link[=quicksight_list_role_memberships]{list_role_memberships} \tab Lists all groups that are associated with a role\cr
#'  \link[=quicksight_list_self_upgrades]{list_self_upgrades} \tab Lists all self-upgrade requests for a Quick account\cr
#'  \link[=quicksight_list_space_resources]{list_space_resources} \tab Lists the resources in an Amazon QuickSight space\cr
#'  \link[=quicksight_list_spaces]{list_spaces} \tab Lists all Amazon QuickSight spaces in an Amazon Web Services account\cr
#'  \link[=quicksight_list_tags_for_resource]{list_tags_for_resource} \tab Lists the tags assigned to a resource\cr
#'  \link[=quicksight_list_template_aliases]{list_template_aliases} \tab Lists all the aliases of a template\cr
#'  \link[=quicksight_list_templates]{list_templates} \tab Lists all the templates in the current Amazon Quick Sight account\cr
#'  \link[=quicksight_list_template_versions]{list_template_versions} \tab Lists all the versions of the templates in the current Amazon Quick Sight account\cr
#'  \link[=quicksight_list_theme_aliases]{list_theme_aliases} \tab Lists all the aliases of a theme\cr
#'  \link[=quicksight_list_themes]{list_themes} \tab Lists all the themes in the current Amazon Web Services account\cr
#'  \link[=quicksight_list_theme_versions]{list_theme_versions} \tab Lists all the versions of the themes in the current Amazon Web Services account\cr
#'  \link[=quicksight_list_topic_refresh_schedules]{list_topic_refresh_schedules} \tab Lists all of the refresh schedules for a topic\cr
#'  \link[=quicksight_list_topic_reviewed_answers]{list_topic_reviewed_answers} \tab Lists all reviewed answers for a Q Topic\cr
#'  \link[=quicksight_list_topics]{list_topics} \tab Lists all of the topics within an account\cr
#'  \link[=quicksight_list_topics_v2]{list_topics_v2} \tab Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region\cr
#'  \link[=quicksight_list_user_groups]{list_user_groups} \tab Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of\cr
#'  \link[=quicksight_list_users]{list_users} \tab Returns a list of all of the Amazon Quick Sight users belonging to this account\cr
#'  \link[=quicksight_list_users_index_capacity]{list_users_index_capacity} \tab Lists per-user index capacity consumption for an account\cr
#'  \link[=quicksight_list_vpc_connections]{list_vpc_connections} \tab Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account\cr
#'  \link[=quicksight_predict_qa_results]{predict_qa_results} \tab Predicts existing visuals or generates new visuals to answer a given query\cr
#'  \link[=quicksight_put_data_set_refresh_properties]{put_data_set_refresh_properties} \tab Creates or updates the dataset refresh properties for the dataset\cr
#'  \link[=quicksight_register_user]{register_user} \tab Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request\cr
#'  \link[=quicksight_restore_analysis]{restore_analysis} \tab Restores an analysis\cr
#'  \link[=quicksight_search_action_connectors]{search_action_connectors} \tab Searches for action connectors in the specified Amazon Web Services account using filters\cr
#'  \link[=quicksight_search_agents]{search_agents} \tab Searches for agents based on specified filters\cr
#'  \link[=quicksight_search_analyses]{search_analyses} \tab Searches for analyses that belong to the user specified in the filter\cr
#'  \link[=quicksight_search_apps]{search_apps} \tab Searches for apps in an Amazon Web Services account using the specified filters\cr
#'  \link[=quicksight_search_dashboards]{search_dashboards} \tab Searches for dashboards that belong to a user\cr
#'  \link[=quicksight_search_data_sets]{search_data_sets} \tab Use the SearchDataSets operation to search for datasets that belong to an account\cr
#'  \link[=quicksight_search_data_sources]{search_data_sources} \tab Use the SearchDataSources operation to search for data sources that belong to an account\cr
#'  \link[=quicksight_search_flows]{search_flows} \tab Search for the flows in an Amazon Web Services account\cr
#'  \link[=quicksight_search_folders]{search_folders} \tab Searches the subfolders in a folder\cr
#'  \link[=quicksight_search_groups]{search_groups} \tab Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters\cr
#'  \link[=quicksight_search_knowledge_bases]{search_knowledge_bases} \tab Searches for a subset of knowledge bases based on specified filters\cr
#'  \link[=quicksight_search_spaces]{search_spaces} \tab Searches for Amazon QuickSight spaces that match the specified filters\cr
#'  \link[=quicksight_search_topics]{search_topics} \tab Searches for any Q topic that exists in an Quick account\cr
#'  \link[=quicksight_search_topics_v2]{search_topics_v2} \tab Searches for any Q topic that exists in an Amazon Web Services account\cr
#'  \link[=quicksight_start_asset_bundle_export_job]{start_asset_bundle_export_job} \tab Starts an Asset Bundle export job\cr
#'  \link[=quicksight_start_asset_bundle_import_job]{start_asset_bundle_import_job} \tab Starts an Asset Bundle import job\cr
#'  \link[=quicksight_start_automation_job]{start_automation_job} \tab Starts a new job for a specified automation\cr
#'  \link[=quicksight_start_dashboard_snapshot_job]{start_dashboard_snapshot_job} \tab Starts an asynchronous job that generates a snapshot of a dashboard's output\cr
#'  \link[=quicksight_start_dashboard_snapshot_job_schedule]{start_dashboard_snapshot_job_schedule} \tab Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email\cr
#'  \link[=quicksight_tag_resource]{tag_resource} \tab Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource\cr
#'  \link[=quicksight_untag_resource]{untag_resource} \tab Removes a tag or tags from a resource\cr
#'  \link[=quicksight_update_account_customization]{update_account_customization} \tab Updates Amazon Quick Sight customizations\cr
#'  \link[=quicksight_update_account_custom_permission]{update_account_custom_permission} \tab Applies a custom permissions profile to an account\cr
#'  \link[=quicksight_update_account_settings]{update_account_settings} \tab Updates the Amazon Quick Sight settings in your Amazon Web Services account\cr
#'  \link[=quicksight_update_action_connector]{update_action_connector} \tab Updates an existing action connector with new configuration details, authentication settings, or enabled actions\cr
#'  \link[=quicksight_update_action_connector_permissions]{update_action_connector_permissions} \tab Updates the permissions for an action connector by granting or revoking access for specific users and groups\cr
#'  \link[=quicksight_update_agent]{update_agent} \tab Updates an existing agent\cr
#'  \link[=quicksight_update_agent_permissions]{update_agent_permissions} \tab Updates the resource permissions for an agent\cr
#'  \link[=quicksight_update_analysis]{update_analysis} \tab Updates an analysis in Amazon Quick Sight\cr
#'  \link[=quicksight_update_analysis_permissions]{update_analysis_permissions} \tab Updates the read and write permissions for an analysis\cr
#'  \link[=quicksight_update_application_with_token_exchange_grant]{update_application_with_token_exchange_grant} \tab Updates an Quick application with a token exchange grant\cr
#'  \link[=quicksight_update_app_permissions]{update_app_permissions} \tab Updates the resource permissions for an app\cr
#'  \link[=quicksight_update_approval_policy]{update_approval_policy} \tab Updates an approval policy in Quick Sight\cr
#'  \link[=quicksight_update_brand]{update_brand} \tab Updates a brand\cr
#'  \link[=quicksight_update_brand_assignment]{update_brand_assignment} \tab Updates a brand assignment\cr
#'  \link[=quicksight_update_brand_published_version]{update_brand_published_version} \tab Updates the published version of a brand\cr
#'  \link[=quicksight_update_custom_permissions]{update_custom_permissions} \tab Updates a custom permissions profile\cr
#'  \link[=quicksight_update_dashboard]{update_dashboard} \tab Updates a dashboard in an Amazon Web Services account\cr
#'  \link[=quicksight_update_dashboard_links]{update_dashboard_links} \tab Updates the linked analyses on a dashboard\cr
#'  \link[=quicksight_update_dashboard_permissions]{update_dashboard_permissions} \tab Updates read and write permissions on a dashboard\cr
#'  \link[=quicksight_update_dashboard_published_version]{update_dashboard_published_version} \tab Updates the published version of a dashboard\cr
#'  \link[=quicksight_update_dashboards_qa_configuration]{update_dashboards_qa_configuration} \tab Updates a Dashboard QA configuration\cr
#'  \link[=quicksight_update_data_set]{update_data_set} \tab Updates a dataset\cr
#'  \link[=quicksight_update_data_set_permissions]{update_data_set_permissions} \tab Updates the permissions on a dataset\cr
#'  \link[=quicksight_update_data_source]{update_data_source} \tab Updates a data source\cr
#'  \link[=quicksight_update_data_source_permissions]{update_data_source_permissions} \tab Updates the permissions to a data source\cr
#'  \link[=quicksight_update_default_q_business_application]{update_default_q_business_application} \tab Updates a Amazon Q Business application that is linked to a Quick Sight account\cr
#'  \link[=quicksight_update_dlp_setting]{update_dlp_setting} \tab Updates an existing DLP setting configuration in an Amazon Web Services account\cr
#'  \link[=quicksight_update_flow]{update_flow} \tab Updates an existing flow\cr
#'  \link[=quicksight_update_flow_permissions]{update_flow_permissions} \tab Updates permissions against principals on a flow\cr
#'  \link[=quicksight_update_folder]{update_folder} \tab Updates the name of a folder\cr
#'  \link[=quicksight_update_folder_permissions]{update_folder_permissions} \tab Updates permissions of a folder\cr
#'  \link[=quicksight_update_group]{update_group} \tab Changes a group description\cr
#'  \link[=quicksight_update_iam_policy_assignment]{update_iam_policy_assignment} \tab Updates an existing IAM policy assignment\cr
#'  \link[=quicksight_update_identity_propagation_config]{update_identity_propagation_config} \tab Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access\cr
#'  \link[=quicksight_update_ip_restriction]{update_ip_restriction} \tab Updates the content and status of IP rules\cr
#'  \link[=quicksight_update_key_registration]{update_key_registration} \tab Updates a customer managed key in a Quick Sight account\cr
#'  \link[=quicksight_update_knowledge_base]{update_knowledge_base} \tab Updates the properties of an existing knowledge base\cr
#'  \link[=quicksight_update_knowledge_base_permissions]{update_knowledge_base_permissions} \tab Updates the resource permissions for a knowledge base\cr
#'  \link[=quicksight_update_limits_profile]{update_limits_profile} \tab Updates the properties of an existing limits profile\cr
#'  \link[=quicksight_update_o_auth_client_application]{update_o_auth_client_application} \tab Updates an OAuthClientApplication\cr
#'  \link[=quicksight_update_public_sharing_settings]{update_public_sharing_settings} \tab This API controls public sharing settings for your entire Quick Sight account, affecting data security and access\cr
#'  \link[=quicksight_update_q_personalization_configuration]{update_q_personalization_configuration} \tab Updates a personalization configuration\cr
#'  \link[=quicksight_update_quick_sight_q_search_configuration]{update_quick_sight_q_search_configuration} \tab Updates the state of a Quick Sight Q Search configuration\cr
#'  \link[=quicksight_update_refresh_schedule]{update_refresh_schedule} \tab Updates a refresh schedule for a dataset\cr
#'  \link[=quicksight_update_role_custom_permission]{update_role_custom_permission} \tab Updates the custom permissions that are associated with a role\cr
#'  \link[=quicksight_update_self_upgrade]{update_self_upgrade} \tab Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request\cr
#'  \link[=quicksight_update_self_upgrade_configuration]{update_self_upgrade_configuration} \tab Updates the self-upgrade configuration for a Quick account\cr
#'  \link[=quicksight_update_space]{update_space} \tab Updates the metadata of an Amazon QuickSight space\cr
#'  \link[=quicksight_update_space_permissions]{update_space_permissions} \tab Updates the permissions for an Amazon QuickSight space\cr
#'  \link[=quicksight_update_space_resources]{update_space_resources} \tab Adds or removes resources from an Amazon QuickSight space\cr
#'  \link[=quicksight_update_spice_capacity_configuration]{update_spice_capacity_configuration} \tab Updates the SPICE capacity configuration for a Quick Sight account\cr
#'  \link[=quicksight_update_template]{update_template} \tab Updates a template from an existing Amazon Quick Sight analysis or another template\cr
#'  \link[=quicksight_update_template_alias]{update_template_alias} \tab Updates the template alias of a template\cr
#'  \link[=quicksight_update_template_permissions]{update_template_permissions} \tab Updates the resource permissions for a template\cr
#'  \link[=quicksight_update_theme]{update_theme} \tab Updates a theme\cr
#'  \link[=quicksight_update_theme_alias]{update_theme_alias} \tab Updates an alias of a theme\cr
#'  \link[=quicksight_update_theme_permissions]{update_theme_permissions} \tab Updates the resource permissions for a theme\cr
#'  \link[=quicksight_update_topic]{update_topic} \tab Updates a topic\cr
#'  \link[=quicksight_update_topic_permissions]{update_topic_permissions} \tab Updates the permissions of a topic\cr
#'  \link[=quicksight_update_topic_permissions_v2]{update_topic_permissions_v2} \tab Updates the permissions of a topic\cr
#'  \link[=quicksight_update_topic_refresh_schedule]{update_topic_refresh_schedule} \tab Updates a topic refresh schedule\cr
#'  \link[=quicksight_update_topic_v2]{update_topic_v2} \tab Updates the definition of a Q topic\cr
#'  \link[=quicksight_update_user]{update_user} \tab Updates an Amazon Quick Sight user\cr
#'  \link[=quicksight_update_user_custom_permission]{update_user_custom_permission} \tab Updates a custom permissions profile for a user\cr
#'  \link[=quicksight_update_vpc_connection]{update_vpc_connection} \tab Updates a VPC connection
#' }
#'
#' @return
#' A client for the service. You can call the service's operations using
#' syntax like `svc$operation(...)`, where `svc` is the name you've assigned
#' to the client. The available operations are listed in the
#' Operations section.
#'
#' @rdname quicksight
#' @export
quicksight <- function(config = list(), credentials = list(), endpoint = NULL, region = NULL) {
  config <- merge_config(
    config,
    list(
      credentials = credentials,
      endpoint = endpoint,
      region = region
    )
  )
  svc <- .quicksight$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.quicksight <- list()

.quicksight$operations <- list()

.quicksight$metadata <- list(
  service_name = "quicksight",
  endpoints = list("^(us|eu|ap|sa|ca|me|af|il|mx)\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.amazonaws.com", global = FALSE), "^cn\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.amazonaws.com.cn", global = FALSE), "^us\\-gov\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.amazonaws.com", global = FALSE), "^us\\-iso\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.c2s.ic.gov", global = FALSE), "^us\\-isob\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.sc2s.sgov.gov", global = FALSE), "^eu\\-isoe\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.cloud.adc-e.uk", global = FALSE), "^us\\-isof\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.csp.hci.ic.gov", global = FALSE), "^eusc\\-(de)\\-\\w+\\-\\d+$" = list(endpoint = "quicksight.{region}.amazonaws.eu", global = FALSE)),
  service_id = "QuickSight",
  api_version = "2018-04-01",
  signing_name = "quicksight",
  json_version = "1.0",
  target_prefix = ""
)

.quicksight$service <- function(config = list(), op = NULL) {
  handlers <- new_handlers("restjson", "v4")
  new_service(.quicksight$metadata, handlers, config, op)
}

Try the paws.analytics package in your browser

Any scripts or data that you put into this service are public.

paws.analytics documentation built on Oct. 8, 2026, 1:09 a.m.