QuickSight

import { QuickSight } from "https://aws-api.deno.dev/v0.2/services/quicksight.ts?docs=full";

class QuickSight {

constructor(apiFactory: client.ApiFactory);

async cancelIngestion(params: CancelIngestionRequest, opts?: client.RequestOptions): Promise<CancelIngestionResponse>;

async createAccountCustomization(params: CreateAccountCustomizationRequest, opts?: client.RequestOptions): Promise<CreateAccountCustomizationResponse>;

async createAnalysis(params: CreateAnalysisRequest, opts?: client.RequestOptions): Promise<CreateAnalysisResponse>;

async createDashboard(params: CreateDashboardRequest, opts?: client.RequestOptions): Promise<CreateDashboardResponse>;

async createDataSet(params: CreateDataSetRequest, opts?: client.RequestOptions): Promise<CreateDataSetResponse>;

async createDataSource(params: CreateDataSourceRequest, opts?: client.RequestOptions): Promise<CreateDataSourceResponse>;

async createFolder(params: CreateFolderRequest, opts?: client.RequestOptions): Promise<CreateFolderResponse>;

async createFolderMembership(params: CreateFolderMembershipRequest, opts?: client.RequestOptions): Promise<CreateFolderMembershipResponse>;

async createGroup(params: CreateGroupRequest, opts?: client.RequestOptions): Promise<CreateGroupResponse>;

async createGroupMembership(params: CreateGroupMembershipRequest, opts?: client.RequestOptions): Promise<CreateGroupMembershipResponse>;

async createIAMPolicyAssignment(params: CreateIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<CreateIAMPolicyAssignmentResponse>;

async createIngestion(params: CreateIngestionRequest, opts?: client.RequestOptions): Promise<CreateIngestionResponse>;

async createNamespace(params: CreateNamespaceRequest, opts?: client.RequestOptions): Promise<CreateNamespaceResponse>;

async createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>;

async createTemplateAlias(params: CreateTemplateAliasRequest, opts?: client.RequestOptions): Promise<CreateTemplateAliasResponse>;

async createTheme(params: CreateThemeRequest, opts?: client.RequestOptions): Promise<CreateThemeResponse>;

async createThemeAlias(params: CreateThemeAliasRequest, opts?: client.RequestOptions): Promise<CreateThemeAliasResponse>;

async deleteAccountCustomization(params: DeleteAccountCustomizationRequest, opts?: client.RequestOptions): Promise<DeleteAccountCustomizationResponse>;

async deleteAnalysis(params: DeleteAnalysisRequest, opts?: client.RequestOptions): Promise<DeleteAnalysisResponse>;

async deleteDashboard(params: DeleteDashboardRequest, opts?: client.RequestOptions): Promise<DeleteDashboardResponse>;

async deleteDataSet(params: DeleteDataSetRequest, opts?: client.RequestOptions): Promise<DeleteDataSetResponse>;

async deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<DeleteDataSourceResponse>;

async deleteFolder(params: DeleteFolderRequest, opts?: client.RequestOptions): Promise<DeleteFolderResponse>;

async deleteFolderMembership(params: DeleteFolderMembershipRequest, opts?: client.RequestOptions): Promise<DeleteFolderMembershipResponse>;

async deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<DeleteGroupResponse>;

async deleteGroupMembership(params: DeleteGroupMembershipRequest, opts?: client.RequestOptions): Promise<DeleteGroupMembershipResponse>;

async deleteIAMPolicyAssignment(params: DeleteIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<DeleteIAMPolicyAssignmentResponse>;

async deleteNamespace(params: DeleteNamespaceRequest, opts?: client.RequestOptions): Promise<DeleteNamespaceResponse>;

async deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<DeleteTemplateResponse>;

async deleteTemplateAlias(params: DeleteTemplateAliasRequest, opts?: client.RequestOptions): Promise<DeleteTemplateAliasResponse>;

async deleteTheme(params: DeleteThemeRequest, opts?: client.RequestOptions): Promise<DeleteThemeResponse>;

async deleteThemeAlias(params: DeleteThemeAliasRequest, opts?: client.RequestOptions): Promise<DeleteThemeAliasResponse>;

async deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<DeleteUserResponse>;

async deleteUserByPrincipalId(params: DeleteUserByPrincipalIdRequest, opts?: client.RequestOptions): Promise<DeleteUserByPrincipalIdResponse>;

async describeAccountCustomization(params: DescribeAccountCustomizationRequest, opts?: client.RequestOptions): Promise<DescribeAccountCustomizationResponse>;

async describeAccountSettings(params: DescribeAccountSettingsRequest, opts?: client.RequestOptions): Promise<DescribeAccountSettingsResponse>;

async describeAnalysis(params: DescribeAnalysisRequest, opts?: client.RequestOptions): Promise<DescribeAnalysisResponse>;

async describeAnalysisPermissions(params: DescribeAnalysisPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeAnalysisPermissionsResponse>;

async describeDashboard(params: DescribeDashboardRequest, opts?: client.RequestOptions): Promise<DescribeDashboardResponse>;

async describeDashboardPermissions(params: DescribeDashboardPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDashboardPermissionsResponse>;

async describeDataSet(params: DescribeDataSetRequest, opts?: client.RequestOptions): Promise<DescribeDataSetResponse>;

async describeDataSetPermissions(params: DescribeDataSetPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDataSetPermissionsResponse>;

async describeDataSource(params: DescribeDataSourceRequest, opts?: client.RequestOptions): Promise<DescribeDataSourceResponse>;

async describeDataSourcePermissions(params: DescribeDataSourcePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDataSourcePermissionsResponse>;

async describeFolder(params: DescribeFolderRequest, opts?: client.RequestOptions): Promise<DescribeFolderResponse>;

async describeFolderPermissions(params: DescribeFolderPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeFolderPermissionsResponse>;

async describeFolderResolvedPermissions(params: DescribeFolderResolvedPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeFolderResolvedPermissionsResponse>;

async describeGroup(params: DescribeGroupRequest, opts?: client.RequestOptions): Promise<DescribeGroupResponse>;

async describeIAMPolicyAssignment(params: DescribeIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<DescribeIAMPolicyAssignmentResponse>;

async describeIngestion(params: DescribeIngestionRequest, opts?: client.RequestOptions): Promise<DescribeIngestionResponse>;

async describeNamespace(params: DescribeNamespaceRequest, opts?: client.RequestOptions): Promise<DescribeNamespaceResponse>;

async describeTemplate(params: DescribeTemplateRequest, opts?: client.RequestOptions): Promise<DescribeTemplateResponse>;

async describeTemplateAlias(params: DescribeTemplateAliasRequest, opts?: client.RequestOptions): Promise<DescribeTemplateAliasResponse>;

async describeTemplatePermissions(params: DescribeTemplatePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeTemplatePermissionsResponse>;

async describeTheme(params: DescribeThemeRequest, opts?: client.RequestOptions): Promise<DescribeThemeResponse>;

async describeThemeAlias(params: DescribeThemeAliasRequest, opts?: client.RequestOptions): Promise<DescribeThemeAliasResponse>;

async describeThemePermissions(params: DescribeThemePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeThemePermissionsResponse>;

async describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>;

async generateEmbedUrlForAnonymousUser(params: GenerateEmbedUrlForAnonymousUserRequest, opts?: client.RequestOptions): Promise<GenerateEmbedUrlForAnonymousUserResponse>;

async generateEmbedUrlForRegisteredUser(params: GenerateEmbedUrlForRegisteredUserRequest, opts?: client.RequestOptions): Promise<GenerateEmbedUrlForRegisteredUserResponse>;

async getDashboardEmbedUrl(params: GetDashboardEmbedUrlRequest, opts?: client.RequestOptions): Promise<GetDashboardEmbedUrlResponse>;

async getSessionEmbedUrl(params: GetSessionEmbedUrlRequest, opts?: client.RequestOptions): Promise<GetSessionEmbedUrlResponse>;

async listAnalyses(params: ListAnalysesRequest, opts?: client.RequestOptions): Promise<ListAnalysesResponse>;

async listDashboards(params: ListDashboardsRequest, opts?: client.RequestOptions): Promise<ListDashboardsResponse>;

async listDashboardVersions(params: ListDashboardVersionsRequest, opts?: client.RequestOptions): Promise<ListDashboardVersionsResponse>;

async listDataSets(params: ListDataSetsRequest, opts?: client.RequestOptions): Promise<ListDataSetsResponse>;

async listDataSources(params: ListDataSourcesRequest, opts?: client.RequestOptions): Promise<ListDataSourcesResponse>;

async listFolderMembers(params: ListFolderMembersRequest, opts?: client.RequestOptions): Promise<ListFolderMembersResponse>;

async listFolders(params: ListFoldersRequest, opts?: client.RequestOptions): Promise<ListFoldersResponse>;

async listGroupMemberships(params: ListGroupMembershipsRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsResponse>;

async listGroups(params: ListGroupsRequest, opts?: client.RequestOptions): Promise<ListGroupsResponse>;

async listIAMPolicyAssignments(params: ListIAMPolicyAssignmentsRequest, opts?: client.RequestOptions): Promise<ListIAMPolicyAssignmentsResponse>;

async listIAMPolicyAssignmentsForUser(params: ListIAMPolicyAssignmentsForUserRequest, opts?: client.RequestOptions): Promise<ListIAMPolicyAssignmentsForUserResponse>;

async listIngestions(params: ListIngestionsRequest, opts?: client.RequestOptions): Promise<ListIngestionsResponse>;

async listNamespaces(params: ListNamespacesRequest, opts?: client.RequestOptions): Promise<ListNamespacesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTemplateAliases(params: ListTemplateAliasesRequest, opts?: client.RequestOptions): Promise<ListTemplateAliasesResponse>;

async listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>;

async listTemplateVersions(params: ListTemplateVersionsRequest, opts?: client.RequestOptions): Promise<ListTemplateVersionsResponse>;

async listThemeAliases(params: ListThemeAliasesRequest, opts?: client.RequestOptions): Promise<ListThemeAliasesResponse>;

async listThemes(params: ListThemesRequest, opts?: client.RequestOptions): Promise<ListThemesResponse>;

async listThemeVersions(params: ListThemeVersionsRequest, opts?: client.RequestOptions): Promise<ListThemeVersionsResponse>;

async listUserGroups(params: ListUserGroupsRequest, opts?: client.RequestOptions): Promise<ListUserGroupsResponse>;

async listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>;

async registerUser(params: RegisterUserRequest, opts?: client.RequestOptions): Promise<RegisterUserResponse>;

async restoreAnalysis(params: RestoreAnalysisRequest, opts?: client.RequestOptions): Promise<RestoreAnalysisResponse>;

async searchAnalyses(params: SearchAnalysesRequest, opts?: client.RequestOptions): Promise<SearchAnalysesResponse>;

async searchDashboards(params: SearchDashboardsRequest, opts?: client.RequestOptions): Promise<SearchDashboardsResponse>;

async searchFolders(params: SearchFoldersRequest, opts?: client.RequestOptions): Promise<SearchFoldersResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<TagResourceResponse>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<UntagResourceResponse>;

async updateAccountCustomization(params: UpdateAccountCustomizationRequest, opts?: client.RequestOptions): Promise<UpdateAccountCustomizationResponse>;

async updateAccountSettings(params: UpdateAccountSettingsRequest, opts?: client.RequestOptions): Promise<UpdateAccountSettingsResponse>;

async updateAnalysis(params: UpdateAnalysisRequest, opts?: client.RequestOptions): Promise<UpdateAnalysisResponse>;

async updateAnalysisPermissions(params: UpdateAnalysisPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateAnalysisPermissionsResponse>;

async updateDashboard(params: UpdateDashboardRequest, opts?: client.RequestOptions): Promise<UpdateDashboardResponse>;

async updateDashboardPermissions(params: UpdateDashboardPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDashboardPermissionsResponse>;

async updateDashboardPublishedVersion(params: UpdateDashboardPublishedVersionRequest, opts?: client.RequestOptions): Promise<UpdateDashboardPublishedVersionResponse>;

async updateDataSet(params: UpdateDataSetRequest, opts?: client.RequestOptions): Promise<UpdateDataSetResponse>;

async updateDataSetPermissions(params: UpdateDataSetPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDataSetPermissionsResponse>;

async updateDataSource(params: UpdateDataSourceRequest, opts?: client.RequestOptions): Promise<UpdateDataSourceResponse>;

async updateDataSourcePermissions(params: UpdateDataSourcePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDataSourcePermissionsResponse>;

async updateFolder(params: UpdateFolderRequest, opts?: client.RequestOptions): Promise<UpdateFolderResponse>;

async updateFolderPermissions(params: UpdateFolderPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateFolderPermissionsResponse>;

async updateGroup(params: UpdateGroupRequest, opts?: client.RequestOptions): Promise<UpdateGroupResponse>;

async updateIAMPolicyAssignment(params: UpdateIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<UpdateIAMPolicyAssignmentResponse>;

async updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<UpdateTemplateResponse>;

async updateTemplateAlias(params: UpdateTemplateAliasRequest, opts?: client.RequestOptions): Promise<UpdateTemplateAliasResponse>;

async updateTemplatePermissions(params: UpdateTemplatePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateTemplatePermissionsResponse>;

async updateTheme(params: UpdateThemeRequest, opts?: client.RequestOptions): Promise<UpdateThemeResponse>;

async updateThemeAlias(params: UpdateThemeAliasRequest, opts?: client.RequestOptions): Promise<UpdateThemeAliasResponse>;

async updateThemePermissions(params: UpdateThemePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateThemePermissionsResponse>;

async updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<UpdateUserResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new QuickSight(apiFactory: client.ApiFactory)

[src]

§Methods

cancelIngestion(params: CancelIngestionRequest, opts?: client.RequestOptions): Promise<CancelIngestionResponse>

[src]

Cancels an ongoing ingestion of data into SPICE.

createAccountCustomization(params: CreateAccountCustomizationRequest, opts?: client.RequestOptions): Promise<CreateAccountCustomizationResponse>

[src]

Creates Amazon QuickSight customizations 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 QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing 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.

createAnalysis(params: CreateAnalysisRequest, opts?: client.RequestOptions): Promise<CreateAnalysisResponse>

[src]

Creates an analysis in Amazon QuickSight.

createDashboard(params: CreateDashboardRequest, opts?: client.RequestOptions): Promise<CreateDashboardResponse>

[src]

Creates a dashboard from a template. To first create a template, see the "CreateTemplate" API operation.

A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share 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;.

createDataSet(params: CreateDataSetRequest, opts?: client.RequestOptions): Promise<CreateDataSetResponse>

[src]

Creates a dataset.

createDataSource(params: CreateDataSourceRequest, opts?: client.RequestOptions): Promise<CreateDataSourceResponse>

[src]

Creates a data source.

createFolder(params: CreateFolderRequest, opts?: client.RequestOptions): Promise<CreateFolderResponse>

[src]

Creates an empty shared folder.

createFolderMembership(params: CreateFolderMembershipRequest, opts?: client.RequestOptions): Promise<CreateFolderMembershipResponse>

[src]

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

createGroup(params: CreateGroupRequest, opts?: client.RequestOptions): Promise<CreateGroupResponse>

[src]

Creates an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:_<relevant-aws-account-id>_:group/default/_<group-name>_.

The response is a group object.

createGroupMembership(params: CreateGroupMembershipRequest, opts?: client.RequestOptions): Promise<CreateGroupMembershipResponse>

[src]

Adds an Amazon QuickSight user to an Amazon QuickSight group.

createIAMPolicyAssignment(params: CreateIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<CreateIAMPolicyAssignmentResponse>

[src]

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.

createIngestion(params: CreateIngestionRequest, opts?: client.RequestOptions): Promise<CreateIngestionResponse>

[src]

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

createNamespace(params: CreateNamespaceRequest, opts?: client.RequestOptions): Promise<CreateNamespaceResponse>

[src]

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

A namespace allows you to isolate the 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 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.

createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>

[src]

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in 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.

createTemplateAlias(params: CreateTemplateAliasRequest, opts?: client.RequestOptions): Promise<CreateTemplateAliasResponse>

[src]

Creates a template alias for a template.

createTheme(params: CreateThemeRequest, opts?: client.RequestOptions): Promise<CreateThemeResponse>

[src]

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.

createThemeAlias(params: CreateThemeAliasRequest, opts?: client.RequestOptions): Promise<CreateThemeAliasResponse>

[src]

Creates a theme alias for a theme.

deleteAccountCustomization(params: DeleteAccountCustomizationRequest, opts?: client.RequestOptions): Promise<DeleteAccountCustomizationResponse>

[src]

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

deleteAnalysis(params: DeleteAnalysisRequest, opts?: client.RequestOptions): Promise<DeleteAnalysisResponse>

[src]

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. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, 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 QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

deleteDashboard(params: DeleteDashboardRequest, opts?: client.RequestOptions): Promise<DeleteDashboardResponse>

[src]

Deletes a dashboard.

deleteDataSet(params: DeleteDataSetRequest, opts?: client.RequestOptions): Promise<DeleteDataSetResponse>

[src]

Deletes a dataset.

deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<DeleteDataSourceResponse>

[src]

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

deleteFolder(params: DeleteFolderRequest, opts?: client.RequestOptions): Promise<DeleteFolderResponse>

[src]

Deletes an empty folder.

deleteFolderMembership(params: DeleteFolderMembershipRequest, opts?: client.RequestOptions): Promise<DeleteFolderMembershipResponse>

[src]

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

deleteGroup(params: DeleteGroupRequest, opts?: client.RequestOptions): Promise<DeleteGroupResponse>

[src]

Removes a user group from Amazon QuickSight.

deleteGroupMembership(params: DeleteGroupMembershipRequest, opts?: client.RequestOptions): Promise<DeleteGroupMembershipResponse>

[src]

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

deleteIAMPolicyAssignment(params: DeleteIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<DeleteIAMPolicyAssignmentResponse>

[src]

Deletes an existing IAM policy assignment.

deleteNamespace(params: DeleteNamespaceRequest, opts?: client.RequestOptions): Promise<DeleteNamespaceResponse>

[src]

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.

deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<DeleteTemplateResponse>

[src]

Deletes a template.

deleteTemplateAlias(params: DeleteTemplateAliasRequest, opts?: client.RequestOptions): Promise<DeleteTemplateAliasResponse>

[src]

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.

deleteTheme(params: DeleteThemeRequest, opts?: client.RequestOptions): Promise<DeleteThemeResponse>

[src]

Deletes a theme.

deleteThemeAlias(params: DeleteThemeAliasRequest, opts?: client.RequestOptions): Promise<DeleteThemeAliasResponse>

[src]

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.

deleteUser(params: DeleteUserRequest, opts?: client.RequestOptions): Promise<DeleteUserResponse>

[src]

Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

deleteUserByPrincipalId(params: DeleteUserByPrincipalIdRequest, opts?: client.RequestOptions): Promise<DeleteUserByPrincipalIdResponse>

[src]

Deletes a user identified by its principal ID.

describeAccountCustomization(params: DescribeAccountCustomizationRequest, opts?: client.RequestOptions): Promise<DescribeAccountCustomizationResponse>

[src]

Describes the customizations associated with the provided Amazon Web Services account; and Amazon QuickSight namespace in an Amazon Web Services Region;. The 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 AWS Services. When you subscribe to 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 QuickSight in any supported Amazon Web Services Region;.
Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to QuickSight at least once, 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 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 AWS 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 AWS 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 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.

describeAccountSettings(params: DescribeAccountSettingsRequest, opts?: client.RequestOptions): Promise<DescribeAccountSettingsResponse>

[src]

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

describeAnalysis(params: DescribeAnalysisRequest, opts?: client.RequestOptions): Promise<DescribeAnalysisResponse>

[src]

Provides a summary of the metadata for an analysis.

describeAnalysisPermissions(params: DescribeAnalysisPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeAnalysisPermissionsResponse>

[src]

Provides the read and write permissions for an analysis.

describeDashboard(params: DescribeDashboardRequest, opts?: client.RequestOptions): Promise<DescribeDashboardResponse>

[src]

Provides a summary for a dashboard.

describeDashboardPermissions(params: DescribeDashboardPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDashboardPermissionsResponse>

[src]

Describes read and write permissions for a dashboard.

describeDataSet(params: DescribeDataSetRequest, opts?: client.RequestOptions): Promise<DescribeDataSetResponse>

[src]

Describes a dataset.

describeDataSetPermissions(params: DescribeDataSetPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDataSetPermissionsResponse>

[src]

Describes the permissions on a dataset.

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

describeDataSource(params: DescribeDataSourceRequest, opts?: client.RequestOptions): Promise<DescribeDataSourceResponse>

[src]

Describes a data source.

describeDataSourcePermissions(params: DescribeDataSourcePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeDataSourcePermissionsResponse>

[src]

Describes the resource permissions for a data source.

describeFolder(params: DescribeFolderRequest, opts?: client.RequestOptions): Promise<DescribeFolderResponse>

[src]

Describes a folder.

describeFolderPermissions(params: DescribeFolderPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeFolderPermissionsResponse>

[src]

Describes permissions for a folder.

describeFolderResolvedPermissions(params: DescribeFolderResolvedPermissionsRequest, opts?: client.RequestOptions): Promise<DescribeFolderResolvedPermissionsResponse>

[src]

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

describeGroup(params: DescribeGroupRequest, opts?: client.RequestOptions): Promise<DescribeGroupResponse>

[src]

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

describeIAMPolicyAssignment(params: DescribeIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<DescribeIAMPolicyAssignmentResponse>

[src]

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

describeIngestion(params: DescribeIngestionRequest, opts?: client.RequestOptions): Promise<DescribeIngestionResponse>

[src]

Describes a SPICE ingestion.

describeNamespace(params: DescribeNamespaceRequest, opts?: client.RequestOptions): Promise<DescribeNamespaceResponse>

[src]

Describes the current namespace.

describeTemplate(params: DescribeTemplateRequest, opts?: client.RequestOptions): Promise<DescribeTemplateResponse>

[src]

Describes a template's metadata.

describeTemplateAlias(params: DescribeTemplateAliasRequest, opts?: client.RequestOptions): Promise<DescribeTemplateAliasResponse>

[src]

Describes the template alias for a template.

describeTemplatePermissions(params: DescribeTemplatePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeTemplatePermissionsResponse>

[src]

Describes read and write permissions on a template.

describeTheme(params: DescribeThemeRequest, opts?: client.RequestOptions): Promise<DescribeThemeResponse>

[src]

Describes a theme.

describeThemeAlias(params: DescribeThemeAliasRequest, opts?: client.RequestOptions): Promise<DescribeThemeAliasResponse>

[src]

Describes the alias for a theme.

describeThemePermissions(params: DescribeThemePermissionsRequest, opts?: client.RequestOptions): Promise<DescribeThemePermissionsResponse>

[src]

Describes the read and write permissions for a theme.

describeUser(params: DescribeUserRequest, opts?: client.RequestOptions): Promise<DescribeUserResponse>

[src]

Returns information about a user, given the user name.

generateEmbedUrlForAnonymousUser(params: GenerateEmbedUrlForAnonymousUserRequest, opts?: client.RequestOptions): Promise<GenerateEmbedUrlForAnonymousUserResponse>

[src]

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard 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 (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

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

generateEmbedUrlForRegisteredUser(params: GenerateEmbedUrlForRegisteredUserRequest, opts?: client.RequestOptions): Promise<GenerateEmbedUrlForRegisteredUserResponse>

[src]

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 (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

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

getDashboardEmbedUrl(params: GetDashboardEmbedUrlRequest, opts?: client.RequestOptions): Promise<GetDashboardEmbedUrlResponse>

[src]

Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. 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 combination of URL and authorization code:

They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.

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.

getSessionEmbedUrl(params: GetSessionEmbedUrlRequest, opts?: client.RequestOptions): Promise<GetSessionEmbedUrlResponse>

[src]

Generates a session URL and authorization code that you can use to embed the 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 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" 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:

listAnalyses(params: ListAnalysesRequest, opts?: client.RequestOptions): Promise<ListAnalysesResponse>

[src]

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

listDashboards(params: ListDashboardsRequest, opts?: client.RequestOptions): Promise<ListDashboardsResponse>

[src]

Lists dashboards in an Amazon Web Services account;.

listDashboardVersions(params: ListDashboardVersionsRequest, opts?: client.RequestOptions): Promise<ListDashboardVersionsResponse>

[src]

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

listDataSets(params: ListDataSetsRequest, opts?: client.RequestOptions): Promise<ListDataSetsResponse>

[src]

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

listDataSources(params: ListDataSourcesRequest, opts?: client.RequestOptions): Promise<ListDataSourcesResponse>

[src]

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

listFolderMembers(params: ListFolderMembersRequest, opts?: client.RequestOptions): Promise<ListFolderMembersResponse>

[src]

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

listFolders(params: ListFoldersRequest, opts?: client.RequestOptions): Promise<ListFoldersResponse>

[src]

Lists all folders in an account.

listGroupMemberships(params: ListGroupMembershipsRequest, opts?: client.RequestOptions): Promise<ListGroupMembershipsResponse>

[src]

Lists member users in a group.

listGroups(params: ListGroupsRequest, opts?: client.RequestOptions): Promise<ListGroupsResponse>

[src]

Lists all user groups in Amazon QuickSight.

listIAMPolicyAssignments(params: ListIAMPolicyAssignmentsRequest, opts?: client.RequestOptions): Promise<ListIAMPolicyAssignmentsResponse>

[src]

Lists IAM policy assignments in the current Amazon QuickSight account.

listIAMPolicyAssignmentsForUser(params: ListIAMPolicyAssignmentsForUserRequest, opts?: client.RequestOptions): Promise<ListIAMPolicyAssignmentsForUserResponse>

[src]

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.

listIngestions(params: ListIngestionsRequest, opts?: client.RequestOptions): Promise<ListIngestionsResponse>

[src]

Lists the history of SPICE ingestions for a dataset.

listNamespaces(params: ListNamespacesRequest, opts?: client.RequestOptions): Promise<ListNamespacesResponse>

[src]

Lists the namespaces for the specified Amazon Web Services account;.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags assigned to a resource.

listTemplateAliases(params: ListTemplateAliasesRequest, opts?: client.RequestOptions): Promise<ListTemplateAliasesResponse>

[src]

Lists all the aliases of a template.

listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>

[src]

Lists all the templates in the current Amazon QuickSight account.

listTemplateVersions(params: ListTemplateVersionsRequest, opts?: client.RequestOptions): Promise<ListTemplateVersionsResponse>

[src]

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

listThemeAliases(params: ListThemeAliasesRequest, opts?: client.RequestOptions): Promise<ListThemeAliasesResponse>

[src]

Lists all the aliases of a theme.

listThemes(params: ListThemesRequest, opts?: client.RequestOptions): Promise<ListThemesResponse>

[src]

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

listThemeVersions(params: ListThemeVersionsRequest, opts?: client.RequestOptions): Promise<ListThemeVersionsResponse>

[src]

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

listUserGroups(params: ListUserGroupsRequest, opts?: client.RequestOptions): Promise<ListUserGroupsResponse>

[src]

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

listUsers(params: ListUsersRequest, opts?: client.RequestOptions): Promise<ListUsersResponse>

[src]

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

registerUser(params: RegisterUserRequest, opts?: client.RequestOptions): Promise<RegisterUserResponse>

[src]

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

restoreAnalysis(params: RestoreAnalysisRequest, opts?: client.RequestOptions): Promise<RestoreAnalysisResponse>

[src]

Restores an analysis.

searchAnalyses(params: SearchAnalysesRequest, opts?: client.RequestOptions): Promise<SearchAnalysesResponse>

[src]

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

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

searchDashboards(params: SearchDashboardsRequest, opts?: client.RequestOptions): Promise<SearchDashboardsResponse>

[src]

Searches for dashboards that belong to a user.

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

searchFolders(params: SearchFoldersRequest, opts?: client.RequestOptions): Promise<SearchFoldersResponse>

[src]

Searches the subfolders in a folder.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<TagResourceResponse>

[src]

Assigns one or more tags (key-value pairs) to the specified 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. QuickSight supports tagging on data set, data source, dashboard, and template.

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

You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for Resource Groups.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<UntagResourceResponse>

[src]

Removes a tag or tags from a resource.

updateAccountCustomization(params: UpdateAccountCustomizationRequest, opts?: client.RequestOptions): Promise<UpdateAccountCustomizationResponse>

[src]

Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme.

You can use customizations for your Amazon Web Services account; or, if you specify a namespace, for a 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.

updateAccountSettings(params: UpdateAccountSettingsRequest, opts?: client.RequestOptions): Promise<UpdateAccountSettingsResponse>

[src]

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

updateAnalysis(params: UpdateAnalysisRequest, opts?: client.RequestOptions): Promise<UpdateAnalysisResponse>

[src]

Updates an analysis in Amazon QuickSight

updateAnalysisPermissions(params: UpdateAnalysisPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateAnalysisPermissionsResponse>

[src]

Updates the read and write permissions for an analysis.

updateDashboard(params: UpdateDashboardRequest, opts?: client.RequestOptions): Promise<UpdateDashboardResponse>

[src]

Updates a dashboard in an Amazon Web Services account;.

Note: 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" API operation.

updateDashboardPermissions(params: UpdateDashboardPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDashboardPermissionsResponse>

[src]

Updates read and write permissions on a dashboard.

updateDashboardPublishedVersion(params: UpdateDashboardPublishedVersionRequest, opts?: client.RequestOptions): Promise<UpdateDashboardPublishedVersionResponse>

[src]

Updates the published version of a dashboard.

updateDataSet(params: UpdateDataSetRequest, opts?: client.RequestOptions): Promise<UpdateDataSetResponse>

[src]

Updates a dataset.

updateDataSetPermissions(params: UpdateDataSetPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDataSetPermissionsResponse>

[src]

Updates the permissions on a dataset.

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

updateDataSource(params: UpdateDataSourceRequest, opts?: client.RequestOptions): Promise<UpdateDataSourceResponse>

[src]

Updates a data source.

updateDataSourcePermissions(params: UpdateDataSourcePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateDataSourcePermissionsResponse>

[src]

Updates the permissions to a data source.

updateFolder(params: UpdateFolderRequest, opts?: client.RequestOptions): Promise<UpdateFolderResponse>

[src]

Updates the name of a folder.

updateFolderPermissions(params: UpdateFolderPermissionsRequest, opts?: client.RequestOptions): Promise<UpdateFolderPermissionsResponse>

[src]

Updates permissions of a folder.

updateGroup(params: UpdateGroupRequest, opts?: client.RequestOptions): Promise<UpdateGroupResponse>

[src]

Changes a group description.

updateIAMPolicyAssignment(params: UpdateIAMPolicyAssignmentRequest, opts?: client.RequestOptions): Promise<UpdateIAMPolicyAssignmentResponse>

[src]

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.

updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<UpdateTemplateResponse>

[src]

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

updateTemplateAlias(params: UpdateTemplateAliasRequest, opts?: client.RequestOptions): Promise<UpdateTemplateAliasResponse>

[src]

Updates the template alias of a template.

updateTemplatePermissions(params: UpdateTemplatePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateTemplatePermissionsResponse>

[src]

Updates the resource permissions for a template.

updateTheme(params: UpdateThemeRequest, opts?: client.RequestOptions): Promise<UpdateThemeResponse>

[src]

Updates a theme.

updateThemeAlias(params: UpdateThemeAliasRequest, opts?: client.RequestOptions): Promise<UpdateThemeAliasResponse>

[src]

Updates an alias of a theme.

updateThemePermissions(params: UpdateThemePermissionsRequest, opts?: client.RequestOptions): Promise<UpdateThemePermissionsResponse>

[src]

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.

updateUser(params: UpdateUserRequest, opts?: client.RequestOptions): Promise<UpdateUserResponse>

[src]

Updates an Amazon QuickSight user.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]