AbstractAmazonQuickSight (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.AbstractAmazonQuickSight

All Implemented Interfaces:

AmazonQuickSight

Direct Known Subclasses:

AbstractAmazonQuickSightAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonQuickSight
extends Object
implements AmazonQuickSight
```
Abstract implementation of AmazonQuickSight. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelIngestionResult`	`cancelIngestion(CancelIngestionRequest request)` Cancels an ongoing ingestion of data into SPICE.
`CreateDashboardResult`	`createDashboard(CreateDashboardRequest request)` Creates a dashboard from a template.
`CreateDataSetResult`	`createDataSet(CreateDataSetRequest request)` Creates a dataset.
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest request)` Creates a data source.
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates an Amazon QuickSight group.
`CreateGroupMembershipResult`	`createGroupMembership(CreateGroupMembershipRequest request)` Adds an Amazon QuickSight user to an Amazon QuickSight group.
`CreateIAMPolicyAssignmentResult`	`createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)` Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
`CreateIngestionResult`	`createIngestion(CreateIngestionRequest request)` Creates and starts a new SPICE ingestion on a dataset
`CreateTemplateResult`	`createTemplate(CreateTemplateRequest request)` Creates a template from an existing QuickSight analysis or template.
`CreateTemplateAliasResult`	`createTemplateAlias(CreateTemplateAliasRequest request)` Creates a template alias for a template.
`DeleteDashboardResult`	`deleteDashboard(DeleteDashboardRequest request)` Deletes a dashboard.
`DeleteDataSetResult`	`deleteDataSet(DeleteDataSetRequest request)` Deletes a dataset.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes the data source permanently.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Removes a user group from Amazon QuickSight.
`DeleteGroupMembershipResult`	`deleteGroupMembership(DeleteGroupMembershipRequest request)` Removes a user from a group so that the user is no longer a member of the group.
`DeleteIAMPolicyAssignmentResult`	`deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)` Deletes an existing IAM policy assignment.
`DeleteTemplateResult`	`deleteTemplate(DeleteTemplateRequest request)` Deletes a template.
`DeleteTemplateAliasResult`	`deleteTemplateAlias(DeleteTemplateAliasRequest request)` Deletes the item that the specified template alias points to.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` 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.
`DeleteUserByPrincipalIdResult`	`deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)` Deletes a user identified by its principal ID.
`DescribeDashboardResult`	`describeDashboard(DescribeDashboardRequest request)` Provides a summary for a dashboard.
`DescribeDashboardPermissionsResult`	`describeDashboardPermissions(DescribeDashboardPermissionsRequest request)` Describes read and write permissions for a dashboard.
`DescribeDataSetResult`	`describeDataSet(DescribeDataSetRequest request)` Describes a dataset.
`DescribeDataSetPermissionsResult`	`describeDataSetPermissions(DescribeDataSetPermissionsRequest request)` Describes the permissions on a dataset.
`DescribeDataSourceResult`	`describeDataSource(DescribeDataSourceRequest request)` Describes a data source.
`DescribeDataSourcePermissionsResult`	`describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)` Describes the resource permissions for a data source.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest request)` Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
`DescribeIAMPolicyAssignmentResult`	`describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)` Describes an existing IAM policy assignment, as specified by the assignment name.
`DescribeIngestionResult`	`describeIngestion(DescribeIngestionRequest request)` Describes a SPICE ingestion.
`DescribeTemplateResult`	`describeTemplate(DescribeTemplateRequest request)` Describes a template's metadata.
`DescribeTemplateAliasResult`	`describeTemplateAlias(DescribeTemplateAliasRequest request)` Describes the template alias for a template.
`DescribeTemplatePermissionsResult`	`describeTemplatePermissions(DescribeTemplatePermissionsRequest request)` Describes read and write permissions on a template.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Returns information about a user, given the user name.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDashboardEmbedUrlResult`	`getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)` Generates a server-side embeddable URL and authorization code.
`ListDashboardsResult`	`listDashboards(ListDashboardsRequest request)` Lists dashboards in an AWS account.
`ListDashboardVersionsResult`	`listDashboardVersions(ListDashboardVersionsRequest request)` Lists all the versions of the dashboards in the QuickSight subscription.
`ListDataSetsResult`	`listDataSets(ListDataSetsRequest request)` Lists all of the datasets belonging to the current AWS account in an AWS Region.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest request)` Lists data sources in current AWS Region that belong to this AWS account.
`ListGroupMembershipsResult`	`listGroupMemberships(ListGroupMembershipsRequest request)` Lists member users in a group.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Lists all user groups in Amazon QuickSight.
`ListIAMPolicyAssignmentsResult`	`listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)` Lists IAM policy assignments in the current Amazon QuickSight account.
`ListIAMPolicyAssignmentsForUserResult`	`listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)` 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.
`ListIngestionsResult`	`listIngestions(ListIngestionsRequest request)` Lists the history of SPICE ingestions for a dataset.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags assigned to a resource.
`ListTemplateAliasesResult`	`listTemplateAliases(ListTemplateAliasesRequest request)` Lists all the aliases of a template.
`ListTemplatesResult`	`listTemplates(ListTemplatesRequest request)` Lists all the templates in the current Amazon QuickSight account.
`ListTemplateVersionsResult`	`listTemplateVersions(ListTemplateVersionsRequest request)` Lists all the versions of the templates in the current Amazon QuickSight account.
`ListUserGroupsResult`	`listUserGroups(ListUserGroupsRequest request)` Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Returns a list of all of the Amazon QuickSight users belonging to this account.
`RegisterUserResult`	`registerUser(RegisterUserRequest request)` Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
`SearchDashboardsResult`	`searchDashboards(SearchDashboardsRequest request)` Searchs for dashboards that belong to a user.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag or tags from a resource.
`UpdateDashboardResult`	`updateDashboard(UpdateDashboardRequest request)` Updates a dashboard in an AWS account.
`UpdateDashboardPermissionsResult`	`updateDashboardPermissions(UpdateDashboardPermissionsRequest request)` Updates read and write permissions on a dashboard.
`UpdateDashboardPublishedVersionResult`	`updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)` Updates the published version of a dashboard.
`UpdateDataSetResult`	`updateDataSet(UpdateDataSetRequest request)` Updates a dataset.
`UpdateDataSetPermissionsResult`	`updateDataSetPermissions(UpdateDataSetPermissionsRequest request)` Updates the permissions on a dataset.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates a data source.
`UpdateDataSourcePermissionsResult`	`updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)` Updates the permissions to a data source.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest request)` Changes a group description.
`UpdateIAMPolicyAssignmentResult`	`updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)` Updates an existing IAM policy assignment.
`UpdateTemplateResult`	`updateTemplate(UpdateTemplateRequest request)` Updates a template from an existing Amazon QuickSight analysis or another template.
`UpdateTemplateAliasResult`	`updateTemplateAlias(UpdateTemplateAliasRequest request)` Updates the template alias of a template.
`UpdateTemplatePermissionsResult`	`updateTemplatePermissions(UpdateTemplatePermissionsRequest request)` Updates the resource permissions for a template.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates an Amazon QuickSight user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - cancelIngestion
```
public CancelIngestionResult cancelIngestion(CancelIngestionRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Cancels an ongoing ingestion of data into SPICE.
    
    Specified by:
    
    cancelIngestion in interface AmazonQuickSight
    
    Returns:
    
    Result of the CancelIngestion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDashboard
```
public CreateDashboardResult createDashboard(CreateDashboardRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
    
    Specified by:
    
    createDashboard in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataSet
```
public CreateDataSetResult createDataSet(CreateDataSetRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates a dataset.
    
    Specified by:
    
    createDataSet in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateDataSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataSource
```
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates a data source.
    
    Specified by:
    
    createDataSource in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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.
    
    Specified by:
    
    createGroup in interface AmazonQuickSight
    
    Parameters:
    
    request - The request object for this operation.
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroupMembership
```
public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Adds an Amazon QuickSight user to an Amazon QuickSight group.
    
    Specified by:
    
    createGroupMembership in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateGroupMembership operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIAMPolicyAssignment
```
public CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
    
    Specified by:
    
    createIAMPolicyAssignment in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateIAMPolicyAssignment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIngestion
```
public CreateIngestionResult createIngestion(CreateIngestionRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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 AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
    
    Specified by:
    
    createIngestion in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateIngestion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTemplate
```
public CreateTemplateResult createTemplate(CreateTemplateRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates a template from an existing 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.
    
    Specified by:
    
    createTemplate in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTemplateAlias
```
public CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates a template alias for a template.
    
    Specified by:
    
    createTemplateAlias in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateTemplateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDashboard
```
public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes a dashboard.
    
    Specified by:
    
    deleteDashboard in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSet
```
public DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes a dataset.
    
    Specified by:
    
    deleteDataSet in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteDataSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
    
    Specified by:
    
    deleteDataSource in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Removes a user group from Amazon QuickSight.
    
    Specified by:
    
    deleteGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroupMembership
```
public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Removes a user from a group so that the user is no longer a member of the group.
    
    Specified by:
    
    deleteGroupMembership in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteGroupMembership operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteIAMPolicyAssignment
```
public DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes an existing IAM policy assignment.
    
    Specified by:
    
    deleteIAMPolicyAssignment in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteIAMPolicyAssignment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTemplate
```
public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes a template.
    
    Specified by:
    
    deleteTemplate in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTemplateAlias
```
public DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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.
    
    Specified by:
    
    deleteTemplateAlias in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteTemplateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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. The IAM user isn't deleted as a result of this call.
    
    Specified by:
    
    deleteUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserByPrincipalId
```
public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes a user identified by its principal ID.
    
    Specified by:
    
    deleteUserByPrincipalId in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteUserByPrincipalId operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDashboard
```
public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Provides a summary for a dashboard.
    
    Specified by:
    
    describeDashboard in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDashboardPermissions
```
public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes read and write permissions for a dashboard.
    
    Specified by:
    
    describeDashboardPermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDashboardPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataSet
```
public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes a dataset.
    
    Specified by:
    
    describeDataSet in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDataSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataSetPermissions
```
public DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes the permissions on a dataset.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
    
    Specified by:
    
    describeDataSetPermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDataSetPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataSource
```
public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes a data source.
    
    Specified by:
    
    describeDataSource in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataSourcePermissions
```
public DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes the resource permissions for a data source.
    
    Specified by:
    
    describeDataSourcePermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeDataSourcePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
    
    Specified by:
    
    describeGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeIAMPolicyAssignment
```
public DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes an existing IAM policy assignment, as specified by the assignment name.
    
    Specified by:
    
    describeIAMPolicyAssignment in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeIAMPolicyAssignment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeIngestion
```
public DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes a SPICE ingestion.
    
    Specified by:
    
    describeIngestion in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeIngestion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTemplate
```
public DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes a template's metadata.
    
    Specified by:
    
    describeTemplate in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTemplateAlias
```
public DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes the template alias for a template.
    
    Specified by:
    
    describeTemplateAlias in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeTemplateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTemplatePermissions
```
public DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Describes read and write permissions on a template.
    
    Specified by:
    
    describeTemplatePermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeTemplatePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Returns information about a user, given the user name.
    
    Specified by:
    
    describeUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDashboardEmbedUrl
```
public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
    
    Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
    
    Specified by:
    
    getDashboardEmbedUrl in interface AmazonQuickSight
    
    Returns:
    
    Result of the GetDashboardEmbedUrl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDashboardVersions
```
public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all the versions of the dashboards in the QuickSight subscription.
    
    Specified by:
    
    listDashboardVersions in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListDashboardVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDashboards
```
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists dashboards in an AWS account.
    
    Specified by:
    
    listDashboards in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListDashboards operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataSets
```
public ListDataSetsResult listDataSets(ListDataSetsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all of the datasets belonging to the current AWS account in an AWS Region.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
    
    Specified by:
    
    listDataSets in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListDataSets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists data sources in current AWS Region that belong to this AWS account.
    
    Specified by:
    
    listDataSources in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroupMemberships
```
public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists member users in a group.
    
    Specified by:
    
    listGroupMemberships in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListGroupMemberships operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all user groups in Amazon QuickSight.
    
    Specified by:
    
    listGroups in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIAMPolicyAssignments
```
public ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists IAM policy assignments in the current Amazon QuickSight account.
    
    Specified by:
    
    listIAMPolicyAssignments in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListIAMPolicyAssignments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIAMPolicyAssignmentsForUser
```
public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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.
    
    Specified by:
    
    listIAMPolicyAssignmentsForUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIngestions
```
public ListIngestionsResult listIngestions(ListIngestionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists the history of SPICE ingestions for a dataset.
    
    Specified by:
    
    listIngestions in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListIngestions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists the tags assigned to a resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTemplateAliases
```
public ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all the aliases of a template.
    
    Specified by:
    
    listTemplateAliases in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListTemplateAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTemplateVersions
```
public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all the versions of the templates in the current Amazon QuickSight account.
    
    Specified by:
    
    listTemplateVersions in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListTemplateVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTemplates
```
public ListTemplatesResult listTemplates(ListTemplatesRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists all the templates in the current Amazon QuickSight account.
    
    Specified by:
    
    listTemplates in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListTemplates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserGroups
```
public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
    
    Specified by:
    
    listUserGroups in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListUserGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Returns a list of all of the Amazon QuickSight users belonging to this account.
    
    Specified by:
    
    listUsers in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerUser
```
public RegisterUserResult registerUser(RegisterUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
    
    Specified by:
    
    registerUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the RegisterUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchDashboards
```
public SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Searchs for dashboards that belong to a user.
    
    Specified by:
    
    searchDashboards in interface AmazonQuickSight
    
    Returns:
    
    Result of the SearchDashboards operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    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 AWS Resource Groups.
    Specified by:
    
    tagResource in interface AmazonQuickSight
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Removes a tag or tags from a resource.
    
    Specified by:
    
    untagResource in interface AmazonQuickSight
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDashboard
```
public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates a dashboard in an AWS account.
    
    Specified by:
    
    updateDashboard in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDashboardPermissions
```
public UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates read and write permissions on a dashboard.
    
    Specified by:
    
    updateDashboardPermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDashboardPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDashboardPublishedVersion
```
public UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates the published version of a dashboard.
    
    Specified by:
    
    updateDashboardPublishedVersion in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDashboardPublishedVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSet
```
public UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates a dataset.
    
    Specified by:
    
    updateDataSet in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDataSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSetPermissions
```
public UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates the permissions on a dataset.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
    
    Specified by:
    
    updateDataSetPermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDataSetPermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates a data source.
    
    Specified by:
    
    updateDataSource in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSourcePermissions
```
public UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates the permissions to a data source.
    
    Specified by:
    
    updateDataSourcePermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateDataSourcePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Changes a group description.
    
    Specified by:
    
    updateGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateIAMPolicyAssignment
```
public UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
    
    Specified by:
    
    updateIAMPolicyAssignment in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateIAMPolicyAssignment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTemplate
```
public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates a template from an existing Amazon QuickSight analysis or another template.
    
    Specified by:
    
    updateTemplate in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTemplateAlias
```
public UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates the template alias of a template.
    
    Specified by:
    
    updateTemplateAlias in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateTemplateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTemplatePermissions
```
public UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates the resource permissions for a template.
    
    Specified by:
    
    updateTemplatePermissions in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateTemplatePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Updates an Amazon QuickSight user.
    
    Specified by:
    
    updateUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonQuickSight
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonQuickSight
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonQuickSight
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonQuickSight

Field Summary

Fields inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancelIngestion

createDashboard

createDataSet

createDataSource

createGroup

createGroupMembership

createIAMPolicyAssignment

createIngestion

createTemplate

createTemplateAlias

deleteDashboard

deleteDataSet

deleteDataSource

deleteGroup

deleteGroupMembership

deleteIAMPolicyAssignment

deleteTemplate

deleteTemplateAlias

deleteUser

deleteUserByPrincipalId

describeDashboard

describeDashboardPermissions

describeDataSet

describeDataSetPermissions

describeDataSource

describeDataSourcePermissions

describeGroup

describeIAMPolicyAssignment

describeIngestion

describeTemplate

describeTemplateAlias

describeTemplatePermissions

describeUser

getDashboardEmbedUrl

listDashboardVersions

listDashboards

listDataSets

listDataSources

listGroupMemberships

listGroups

listIAMPolicyAssignments

listIAMPolicyAssignmentsForUser

listIngestions

listTagsForResource

listTemplateAliases

listTemplateVersions

listTemplates

listUserGroups

listUsers

registerUser

searchDashboards

tagResource

untagResource

updateDashboard

updateDashboardPermissions

updateDashboardPublishedVersion

updateDataSet

updateDataSetPermissions

updateDataSource

updateDataSourcePermissions

updateGroup

updateIAMPolicyAssignment

updateTemplate

updateTemplateAlias

updateTemplatePermissions

updateUser

shutdown

getCachedResponseMetadata