amazon-quicksight — quality + safety report

---
name: amazon-quicksight
description: "Amazon QuickSight API skill. Use when working with Amazon QuickSight for accounts, account, resources. Covers 177 endpoints."
version: 1.0.0
generator: lapsh
---

# Amazon QuickSight
API version: 2018-04-01

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /accounts/{AwsAccountId}/customizations -- verify access
3. POST /accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers -- create first batch-create-reviewed-answers

## Endpoints

177 endpoints across 3 groups. See references/api-spec.lap for full details.

### accounts
| Method | Path | Description |
|--------|------|-------------|
| POST | /accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers | Creates new reviewed answers for a Q Topic. |
| POST | /accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers | Deletes reviewed answers for Q Topic. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} | Cancels an ongoing ingestion of data into SPICE. |
| POST | /accounts/{AwsAccountId}/customizations | 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  API operation. To share the theme, grant permissions by using the  UpdateThemePermissions  API operation. |
| POST | /accounts/{AwsAccountId}/analyses/{AnalysisId} | Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition. |
| POST | /accounts/{AwsAccountId}/dashboards/{DashboardId} | Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the  CreateTemplate  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. |
| POST | /accounts/{AwsAccountId}/data-sets | Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. |
| POST | /accounts/{AwsAccountId}/data-sources | Creates a data source. |
| POST | /accounts/{AwsAccountId}/folders/{FolderId} | Creates an empty shared folder. |
| PUT | /accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId} | Adds an asset, such as a dashboard, analysis, or dataset into a folder. |
| POST | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups | Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object. |
| PUT | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName} | Adds an Amazon QuickSight user to an Amazon QuickSight group. |
| POST | /accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/ | 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. |
| PUT | /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} | 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. |
| POST | /accounts/{AwsAccountId} | (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. |
| POST | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules | Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset. |
| POST | /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName} | Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role. |
| POST | /accounts/{AwsAccountId}/templates/{TemplateId} | 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. |
| POST | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | Creates a template alias for a template. |
| POST | /accounts/{AwsAccountId}/themes/{ThemeId} | 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. |
| POST | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | Creates a theme alias for a theme. |
| POST | /accounts/{AwsAccountId}/topics | Creates a new Q topic. |
| POST | /accounts/{AwsAccountId}/topics/{TopicId}/schedules | Creates a topic refresh schedule. |
| POST | /accounts/{AwsAccountId}/vpc-connections | Creates a new VPC connection. |
| DELETE | /accounts/{AwsAccountId}/customizations | Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace. |
| DELETE | /accounts/{AwsAccountId}/analyses/{AnalysisId} | 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 | /accounts/{AwsAccountId}/dashboards/{DashboardId} | Deletes a dashboard. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId} | Deletes a dataset. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties | Deletes the dataset refresh properties of the dataset. |
| DELETE | /accounts/{AwsAccountId}/data-sources/{DataSourceId} | Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source. |
| DELETE | /accounts/{AwsAccountId}/folders/{FolderId} | Deletes an empty folder. |
| DELETE | /accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId} | Removes an asset, such as a dashboard, analysis, or dataset, from a folder. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} | Removes a user group from Amazon QuickSight. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName} | Removes a user from a group so that the user is no longer a member of the group. |
| DELETE | /accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName} | Deletes an existing IAM policy assignment. |
| DELETE | /accounts/{AwsAccountId}/identity-propagation-config/{Service} | 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 | /accounts/{AwsAccountId}/namespaces/{Namespace} | 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 | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId} | Deletes a refresh schedule from a dataset. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission | Removes custom permissions from the role. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName} | Removes a group from a role. |
| DELETE | /accounts/{AwsAccountId}/templates/{TemplateId} | Deletes a template. |
| DELETE | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | 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 | /accounts/{AwsAccountId}/themes/{ThemeId} | Deletes a theme. |
| DELETE | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | 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 alia

… (truncated)