paws.analytics (version 0.1.6)

quicksight: Amazon QuickSight

Description

Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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.

Usage

quicksight(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- quicksight(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

cancel_ingestion	Cancels an ongoing ingestion of data into SPICE
create_dashboard	Creates a dashboard from a template
create_data_set	Creates a dataset
create_data_source	Creates a data source
create_group	Creates an Amazon QuickSight group
create_group_membership	Adds an Amazon QuickSight user to an Amazon QuickSight group
create_iam_policy_assignment	Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN)
create_ingestion	Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control
create_template	Creates a template from an existing QuickSight analysis or template
create_template_alias	Creates a template alias for a template
delete_dashboard	Deletes a dashboard
delete_data_set	Deletes a dataset
delete_data_source	Deletes the data source permanently
delete_group	Removes a user group from Amazon QuickSight
delete_group_membership	Removes a user from a group so that the user is no longer a member of the group
delete_iam_policy_assignment	Deletes an existing IAM policy assignment
delete_template	Deletes a template
delete_template_alias	Deletes the item that the specified template alias points to
delete_user	Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call
delete_user_by_principal_id	Deletes a user identified by its principal ID
describe_dashboard	Provides a summary for a dashboard
describe_dashboard_permissions	Describes read and write permissions for a dashboard
describe_data_set	Describes a dataset
describe_data_set_permissions	Describes the permissions on a dataset
describe_data_source	Describes a data source
describe_data_source_permissions	Describes the resource permissions for a data source
describe_group	Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN)
describe_iam_policy_assignment	Describes an existing IAM policy assignment, as specified by the assignment name
describe_ingestion	Describes a SPICE ingestion
describe_template	Describes a template's metadata
describe_template_alias	Describes the template alias for a template
describe_template_permissions	Describes read and write permissions on a template
describe_user	Returns information about a user, given the user name
get_dashboard_embed_url	Generates a server-side embeddable URL and authorization code
list_dashboards	Lists dashboards in an AWS account
list_dashboard_versions	Lists all the versions of the dashboards in the QuickSight subscription
list_data_sets	Lists all of the datasets belonging to the current AWS account in an AWS Region
list_data_sources	Lists data sources in current AWS Region that belong to this AWS account
list_group_memberships	Lists member users in a group
list_groups	Lists all user groups in Amazon QuickSight
list_iam_policy_assignments	Lists IAM policy assignments in the current Amazon QuickSight account
list_iam_policy_assignments_for_user	Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to
list_ingestions	Lists the history of SPICE ingestions for a dataset
list_tags_for_resource	Lists the tags assigned to a resource
list_template_aliases	Lists all the aliases of a template
list_templates	Lists all the templates in the current Amazon QuickSight account
list_template_versions	Lists all the versions of the templates in the current Amazon QuickSight account
list_user_groups	Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of
list_users	Returns a list of all of the Amazon QuickSight users belonging to this account
register_user	Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request
tag_resource	Assigns one or more tags (key-value pairs) to the specified QuickSight resource
untag_resource	Removes a tag or tags from a resource
update_dashboard	Updates a dashboard in an AWS account
update_dashboard_permissions	Updates read and write permissions on a dashboard
update_dashboard_published_version	Updates the published version of a dashboard
update_data_set	Updates a dataset
update_data_set_permissions	Updates the permissions on a dataset
update_data_source	Updates a data source
update_data_source_permissions	Updates the permissions to a data source
update_group	Changes a group description
update_iam_policy_assignment	Updates an existing IAM policy assignment
update_template	Updates a template from an existing Amazon QuickSight analysis or another template
update_template_alias	Updates the template alias of a template
update_template_permissions	Updates the resource permissions for a template

Examples

# NOT RUN {
svc <- quicksight()
svc$cancel_ingestion(
  Foo = 123
)
# }
# NOT RUN {
# }