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 on-going 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 ARN and will assigned to specified groups or users of QuickSight.
`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 assignment.
`DeleteTemplateResult`	`deleteTemplate(DeleteTemplateRequest request)` Deletes a template.
`DeleteTemplateAliasResult`	`deleteTemplateAlias(DeleteTemplateAliasRequest request)` Update template alias of given template.
`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 on 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 IAMPolicy Assignment by specified 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 aliases of 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 the 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 this 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 assignments in current QuickSight account.
`ListIAMPolicyAssignmentsForUserResult`	`listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)` Lists all the assignments and the ARNs for the associated IAM policies assigned to the specified user and the 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 QuickSight account.
`ListTemplateVersionsResult`	`listTemplateVersions(ListTemplateVersionsRequest request)` Lists all the versions of the templates in the 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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns a tag or tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag or tags from a resource.
`UpdateDashboardResult`	`updateDashboard(UpdateDashboardRequest request)` Updates a dashboard in the 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 assignment.
`UpdateTemplateResult`	`updateTemplate(UpdateTemplateRequest request)` Updates a template from an existing QuickSight analysis.
`UpdateTemplateAliasResult`	`updateTemplateAlias(UpdateTemplateAliasRequest request)` Updates the template alias of a template.
`UpdateTemplatePermissionsResult`	`updateTemplatePermissions(UpdateTemplatePermissionsRequest request)` Updates the permissions on 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 on-going 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.
    
    A dashboard is an entity in QuickSight which identifies Quicksight reports, created from analyses. QuickSight dashboards are sharable. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard and ListDashboardsByUser APIs 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.
    
    CLI syntax:
    
    aws quicksight create-dashboard --cli-input-json file://create-dashboard.json
    
    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.
    
    CLI syntax:
    
    aws quicksight create-data-set \
    
    --aws-account-id=111122223333 \
    
    --data-set-id=unique-data-set-id \
    
    --name='My dataset' \
    
    --import-mode=SPICE \
    
    --physical-table-map='{
    
    "physical-table-id": {
    
    "RelationalTable": {
    
    "DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
    
    "Name": "table1",
    
    "InputColumns": [
    
    {
    
    "Name": "column1",
    
    "Type": "STRING"
    
    }
    
    ]
    
    }
    
    }'
    
    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.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
    
    CLI syntax:
    
    aws quicksight create-data-source \
    
    --aws-account-id=111122223333 \
    
    --data-source-id=unique-data-source-id \
    
    --name='My Data Source' \
    
    --type=POSTGRESQL \
    
    --data-source-parameters='{ "PostgreSqlParameters": {
    
    "Host": "my-db-host.example.com",
    
    "Port": 1234,
    
    "Database": "my-db" } }' \
    
    --credentials='{ "CredentialPair": {
    
    "Username": "username",
    
    "Password": "password" } }'
    
    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.
    
    CLI Sample:
    
    aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    The condition resource is the user name.
    
    The condition key is quicksight:UserName.
    
    The response is the group member object.
    
    CLI Sample:
    
    aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
    
    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 ARN and will assigned to specified groups or users of QuickSight. Users and groups need to be in the same namespace.
    
    CLI syntax:
    
    aws quicksight create-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=helpAssignment --policy-arn=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user5,engineer123,group=QS-Admin" --namespace=default --region=us-west-2
    
    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?. Tags will be 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. The resulting template can be used to create a dashboard.
    
    A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be used to create dashboard. It adds a layer of abstraction by use placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets which follow the same schema that was used to create the source analysis and template.
    
    To create a template from an existing analysis, use the analysis's ARN, aws-account-id, template-id, source-entity, and data-set-references.
    
    CLI syntax to create a template:
    
    aws quicksight create-template —cli-input-json file://create-template.json
    
    CLI syntax to create a template from another template in the same AWS account:
    
    aws quicksight create-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0dfc789c-81f6-4f4f-b9ac-7db2453eefc8 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/f60da323-af68-45db-9016-08e0d1d7ded5 --source-entity SourceAnalysis='{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/7fb74527-c36d-4be8-8139-ac1be4c97365}'
    
    To create template from another account’s template, you need to grant cross account resource permission for DescribeTemplate the account that contains the template.
    
    You can use a file to pass JSON to the function if you prefer.
    
    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.
    
    CLI syntax:
    
    aws quicksight create-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name PROD —version-number 1
    
    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.
    
    CLI syntax:
    
    aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123
    
    aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123 —version-number 3
    
    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.
    
    CLI syntax:
    
    aws quicksight delete-data-set \
    
    --aws-account-id=111111111111 \
    
    --data-set-id=unique-data-set-id
    
    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.
    
    CLI syntax:
    
    aws quicksight delete-data-source \
    
    --aws-account-id=111122223333 \
    
    --data-source-id=unique-data-source-id
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    CLI Sample:
    
    aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    The condition resource is the user name.
    
    The condition key is quicksight:UserName.
    
    CLI Sample:
    
    aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
    
    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 assignment.
    
    CLI syntax:
    
    aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default
    
    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.
    
    CLI syntax:
    - aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template --version-number 2
    - aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name STAGING
    - aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name ‘\$LATEST’
    - aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template
    If version number which is an optional field is not passed the template (including all the versions) is deleted by the API, if version number is provided, the specific template version is deleted by the API.
    
    Users can explicitly describe the latest version of the template by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the 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
    
    Update template alias of given template.
    
    CLI syntax:
    
    aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
    
    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.
    
    CLI Sample:
    
    aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
    
    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.
    
    CLI Sample:
    
    aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
    
    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.
    
    CLI syntax:
    - aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -version-number 2
    - aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -alias-name ‘$PUBLISHED’
    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 on a dashboard.
    
    CLI syntax:
    
    aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report
    
    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.
    
    CLI syntax:
    
    aws quicksight describe-data-set \
    
    --aws-account-id=111111111111 \
    
    --data-set-id=unique-data-set-id
    
    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
    
    CLI syntax:
    
    aws quicksight describe-data-set-permissions \
    
    --aws-account-id=111122223333 \
    
    --data-set-id=unique-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.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
    
    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.
    
    The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id
    
    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).
    
    The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
    
    The response is the group object.
    
    CLI Sample:
    
    aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
    
    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 IAMPolicy Assignment by specified assignment name.
    
    CLI syntax:
    
    aws quicksight describe-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --namespace=default --region=us-east-1
    
    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.
    
    CLI syntax:
    
    aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template
    
    aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --version-number-2
    
    aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --alias-name '\$LATEST'
    
    Users can explicitly describe the latest version of the dashboard by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the dashboard.
    
    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 aliases of a template.
    
    CLI syntax:
    
    aws quicksight describe-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
    
    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.
    
    CLI syntax:
    
    aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_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.
    
    The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
    
    CLI Sample:
    
    aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
    
    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. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
    
    Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
    
    CLI Sample:
    
    Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.
    
    aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
    
    If the user does not exist in QuickSight, register the user:
    
    aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email [email protected] --region us-east-1
    
    Get the URL for the embedded dashboard (IAM identity authentication):
    
    aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
    
    Get the URL for the embedded dashboard (QUICKSIGHT identity authentication):
    
    aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type QUICKSIGHT --user-arn arn:aws:quicksight:us-east-1:111122223333:user/default/embedding_quicksight_dashboard_role/embeddingsession
    
    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.
    
    CLI syntax:
    
    aws quicksight list-template-versions —aws-account-id 111122223333 —template-id reports-test-template
    
    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 the AWS account.
    
    CLI syntax:
    
    aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'
    
    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 this account in an AWS region.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
    
    CLI syntax: aws quicksight list-data-sets --aws-account-id=111111111111
    
    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.
    
    The permissions resource is: arn:aws:quicksight:region:aws-account-id:datasource/*
    
    CLI syntax: aws quicksight list-data-sources --aws-account-id=111122223333
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    The response is a list of group member objects.
    
    CLI Sample:
    
    aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
    
    The response is a list of group objects.
    
    CLI Sample:
    
    aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
    
    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 assignments in current QuickSight account.
    
    CLI syntax:
    
    aws quicksight list-iam-policy-assignments --aws-account-id=111122223333 --max-result=5 --assignment-status=ENABLED --namespace=default --region=us-east-1 --next-token=3
    
    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 assignments and the ARNs for the associated IAM policies assigned to the specified user and the group or groups that the user belongs to.
    
    CLI syntax:
    
    aws quicksight list-iam-policy-assignments-for-user --aws-account-id=111122223333 --user-name=user5 --namespace=default --max-result=6 --region=us-east-1
    
    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.
    
    CLI syntax:
    - aws quicksight list-tags-for-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --region us-east-1
    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.
    
    CLI syntax:
    
    aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_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 Quicksight account.
    
    CLI syntax:
    
    aws quicksight list-template-versions --aws-account-id 111122223333 --aws-account-id 196359894473 --template-id reports-test-template
    
    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 QuickSight account.
    
    CLI syntax:
    
    aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn
    
    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.
    
    The response is a one or more group objects.
    
    CLI Sample:
    
    aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
    
    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.
    
    The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
    
    CLI Sample:
    
    aws quicksight list-users --aws-account-id=111122223333 --namespace=default
    
    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.
    
    CLI Sample:
    
    aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\[email protected] -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
    
    Specified by:
    
    registerUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the RegisterUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonQuickSight
    Assigns a tag or tags to a resource.
    
    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 action 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, template.
    
    Tagging for QuickSight works in a similar was to tagging for other AWS services, except for the following:
    - You can't use tags to track AWS costs for QuickSight, 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.
    CLI syntax to tag a resource:
    - aws quicksight tag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tags Key=K1,Value=V1 Key=K2,Value=V2 --region us-east-1
    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.
    
    CLI syntax:
    - aws quicksight untag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tag-keys K1 K2 --region us-east-1
    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 the AWS account.
    
    CLI syntax:
    
    aws quicksight update-dashboard --aws-account-id 111122223333 --dashboard-id 123123123 --dashboard-name "test-update102" --source-entity SourceTemplate={Arn=arn:aws:quicksight:us-west-2:111122223333:template/sales-report-template2} --data-set-references DataSetPlaceholder=SalesDataSet,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0e251aef-9ebf-46e1-b852-eb4fa33c1d3a
    
    aws quicksight update-dashboard --cli-input-json file://update-dashboard.json
    
    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.
    
    CLI syntax:
    
    aws quicksight update-dashboard-permissions —cli-input-json file://update-permission.json
    
    A sample update-permissions.json for granting read only permissions:
    
    { "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard" ] } ] }
    
    A sample update-permissions.json for granting read and write permissions:
    
    { "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
    
    A sample update-permissions.json for revoking write permissions:
    
    { "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
    
    A sample update-permissions.json for revoking read and write permissions:
    
    { "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
    
    To obtain the principal name of a QuickSight user or group, you can use describe-group or describe-user. For example:
    
    aws quicksight describe-user --aws-account-id 111122223333 --namespace default --user-name user2 --region us-east-1 { "User": { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Active": true, "Email": "[email protected]", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }
    
    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.
    
    CLI syntax:
    
    aws quicksight update-dashboard-published-version --aws-account-id 111122223333 --dashboard-id dashboard-w1 ---version-number 2
    
    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.
    
    CLI syntax:
    
    aws quicksight update-data-set \
    
    --aws-account-id=111122223333 \
    
    --data-set-id=unique-data-set-id \
    
    --name='My dataset' \
    
    --import-mode=SPICE \
    
    --physical-table-map='{
    
    "physical-table-id": {
    
    "RelationalTable": {
    
    "DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
    
    "Name": "table1",
    
    "InputColumns": [
    
    {
    
    "Name": "column1",
    
    "Type": "STRING"
    
    }
    
    ]
    
    }
    
    }'
    
    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
    
    CLI syntax:
    
    aws quicksight update-data-set-permissions \
    
    --aws-account-id=111122223333 \
    
    --data-set-id=unique-data-set-id \
    
    --grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSet","quicksight:DescribeDataSetPermissions","quicksight:PassDataSet","quicksight:ListIngestions","quicksight:DescribeIngestion"]}]' \
    
    --revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSet","quicksight:DeleteDataSet","quicksight:UpdateDataSetPermissions","quicksight:CreateIngestion","quicksight:CancelIngestion"]}]'
    
    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.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
    
    CLI syntax:
    
    aws quicksight update-data-source \
    
    --aws-account-id=111122223333 \
    
    --data-source-id=unique-data-source-id \
    
    --name='My Data Source' \
    
    --data-source-parameters='{"PostgreSqlParameters":{"Host":"my-db-host.example.com","Port":1234,"Database":"my-db"}}' \
    
    --credentials='{"CredentialPair":{"Username":"username","Password":"password"}}
    
    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.
    
    The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
    
    CLI syntax:
    
    aws quicksight update-data-source-permissions \
    
    --aws-account-id=111122223333 \
    
    --data-source-id=unique-data-source-id \
    
    --name='My Data Source' \
    
    --grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSource","quicksight:DescribeDataSourcePermissions","quicksight:PassDataSource"]}]' \
    
    --revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSource","quicksight:DeleteDataSource","quicksight:UpdateDataSourcePermissions"]}]'
    
    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.
    
    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
    
    The response is a group object.
    
    CLI Sample:
    
    aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
    
    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 assignment. This operation updates only the optional parameter or parameters that are specified in the request.
    
    CLI syntax:
    
    aws quicksight update-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=FullAccessAssignment --assignment-status=DRAFT --policy-arns=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user-1,user-2,group=admin" --namespace=default --region=us-east-1
    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 QuickSight analysis. CLI syntax: aws quicksight update-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/c684a204-d134-4c53-a63c-451f72c60c28 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/15840b7d-b542-4491-937b-602416b367b3 —source-entity SourceAnalysis=’{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/c5731fe9-4708-4598-8f6d-cf2a70875b6d} You can also pass in a json file: aws quicksight update-template —cli-input-json file://create-template.json 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. CLI syntax: aws quicksight update-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name STAGING —template-version-number 2 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 permissions on a template. CLI syntax: aws quicksight describe-template-permissions —aws-account-id 111122223333 —template-id reports_test_template aws quicksight update-template-permissions —cli-input-json file://update-permission.json The structure of update-permissions.json to add permissions: { "AwsAccountId": "111122223333", "DashboardId": "reports_test_template", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3", "Actions": [ "quicksight:DescribeTemplate", "quicksight:ListTemplateVersions" ] } ] } The structure of update-permissions.json to add permissions: { "AwsAccountId": "111122223333", "DashboardId": "reports_test_template", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3", "Actions": [ "quicksight:DescribeTemplate", "quicksight:ListTemplateVersions" ] } ] } To obtain the principal name of a QuickSight group or user, use user describe-group or describe-user. For example: aws quicksight describe-user --aws-account-id 111122223333 --namespace default --user-name user2 --region us-east-1 { "User": { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Active": true, "Email": "[email protected]", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 } 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. The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: aws quicksight update-user --user-name=Pat --role=ADMIN [email protected] --aws-account-id=111122223333 --namespace=default --region=us-east-1 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

tagResource

untagResource

updateDashboard

updateDashboardPermissions

updateDashboardPublishedVersion

updateDataSet

updateDataSetPermissions

updateDataSource

updateDataSourcePermissions

updateGroup

updateIAMPolicyAssignment

updateTemplate

updateTemplateAlias

updateTemplatePermissions

updateUser

shutdown

getCachedResponseMetadata