@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightAsyncClient extends AmazonQuickSightClient implements AmazonQuickSightAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, 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, getCachedResponseMetadata, getDashboardEmbedUrl, listDashboards, listDashboardVersions, listDataSets, listDataSources, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listUserGroups, listUsers, registerUser, tagResource, untagResource, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateGroup, updateIAMPolicyAssignment, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateUseraddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelIngestion, 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, getCachedResponseMetadata, getDashboardEmbedUrl, listDashboards, listDashboardVersions, listDataSets, listDataSources, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listUserGroups, listUsers, registerUser, tagResource, untagResource, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateGroup, updateIAMPolicyAssignment, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateUserpublic static AmazonQuickSightAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request)
AmazonQuickSightAsyncCancels an on-going ingestion of data into SPICE.
cancelIngestionAsync in interface AmazonQuickSightAsyncpublic Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request, AsyncHandler<CancelIngestionRequest,CancelIngestionResult> asyncHandler)
AmazonQuickSightAsyncCancels an on-going ingestion of data into SPICE.
cancelIngestionAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest request)
AmazonQuickSightAsyncCreates 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
createDashboardAsync in interface AmazonQuickSightAsyncpublic Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest request, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
AmazonQuickSightAsyncCreates 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
createDashboardAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest request)
AmazonQuickSightAsyncCreates 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"
}
]
}
}'
createDataSetAsync in interface AmazonQuickSightAsyncpublic Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest request, AsyncHandler<CreateDataSetRequest,CreateDataSetResult> asyncHandler)
AmazonQuickSightAsyncCreates 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"
}
]
}
}'
createDataSetAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request)
AmazonQuickSightAsyncCreates 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" } }'
createDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
AmazonQuickSightAsyncCreates 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" } }'
createDataSourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AmazonQuickSightAsyncCreates 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"
createGroupAsync in interface AmazonQuickSightAsyncrequest - The request object for this operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AmazonQuickSightAsyncCreates 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"
createGroupAsync in interface AmazonQuickSightAsyncrequest - The request object for this operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request)
AmazonQuickSightAsyncAdds 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
createGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
AmazonQuickSightAsyncAdds 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
createGroupMembershipAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest request)
AmazonQuickSightAsyncCreates 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
createIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest request, AsyncHandler<CreateIAMPolicyAssignmentRequest,CreateIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncCreates 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
createIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest request)
AmazonQuickSightAsyncCreates 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.
createIngestionAsync in interface AmazonQuickSightAsyncpublic Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest request, AsyncHandler<CreateIngestionRequest,CreateIngestionResult> asyncHandler)
AmazonQuickSightAsyncCreates 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.
createIngestionAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request)
AmazonQuickSightAsyncCreates 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.
createTemplateAsync in interface AmazonQuickSightAsyncpublic Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
AmazonQuickSightAsyncCreates 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.
createTemplateAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest request)
AmazonQuickSightAsyncCreates 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
createTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest request, AsyncHandler<CreateTemplateAliasRequest,CreateTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncCreates 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
createTemplateAliasAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest request)
AmazonQuickSightAsyncDeletes 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
deleteDashboardAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest request, AsyncHandler<DeleteDashboardRequest,DeleteDashboardResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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
deleteDashboardAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest request)
AmazonQuickSightAsyncDeletes a dataset.
CLI syntax:
aws quicksight delete-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
deleteDataSetAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest request, AsyncHandler<DeleteDataSetRequest,DeleteDataSetResult> asyncHandler)
AmazonQuickSightAsyncDeletes a dataset.
CLI syntax:
aws quicksight delete-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
deleteDataSetAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request)
AmazonQuickSightAsyncDeletes 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
deleteDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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
deleteDataSourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AmazonQuickSightAsyncRemoves 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
deleteGroupAsync in interface AmazonQuickSightAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AmazonQuickSightAsyncRemoves 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
deleteGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request)
AmazonQuickSightAsyncRemoves 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
deleteGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request, AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)
AmazonQuickSightAsyncRemoves 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
deleteGroupMembershipAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest request)
AmazonQuickSightAsyncDeletes an existing assignment.
CLI syntax:
aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default
deleteIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest request, AsyncHandler<DeleteIAMPolicyAssignmentRequest,DeleteIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncDeletes an existing assignment.
CLI syntax:
aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default
deleteIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request)
AmazonQuickSightAsyncDeletes 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.
deleteTemplateAsync in interface AmazonQuickSightAsyncpublic Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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.
deleteTemplateAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest request)
AmazonQuickSightAsyncUpdate template alias of given template.
CLI syntax:
aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
deleteTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest request, AsyncHandler<DeleteTemplateAliasRequest,DeleteTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncUpdate template alias of given template.
CLI syntax:
aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
deleteTemplateAliasAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonQuickSightAsyncDeletes 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
deleteUserAsync in interface AmazonQuickSightAsyncpublic Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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
deleteUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request)
AmazonQuickSightAsyncDeletes 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
deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsyncpublic Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
AmazonQuickSightAsyncDeletes 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
deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest request)
AmazonQuickSightAsyncProvides 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’
describeDashboardAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest request, AsyncHandler<DescribeDashboardRequest,DescribeDashboardResult> asyncHandler)
AmazonQuickSightAsyncProvides 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’
describeDashboardAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest request)
AmazonQuickSightAsyncDescribes read and write permissions on a dashboard.
CLI syntax:
aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report
describeDashboardPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest request, AsyncHandler<DescribeDashboardPermissionsRequest,DescribeDashboardPermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes read and write permissions on a dashboard.
CLI syntax:
aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report
describeDashboardPermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest request)
AmazonQuickSightAsyncDescribes a dataset.
CLI syntax:
aws quicksight describe-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
describeDataSetAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest request, AsyncHandler<DescribeDataSetRequest,DescribeDataSetResult> asyncHandler)
AmazonQuickSightAsyncDescribes a dataset.
CLI syntax:
aws quicksight describe-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
describeDataSetAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest request)
AmazonQuickSightAsyncDescribes 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 \
describeDataSetPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest request, AsyncHandler<DescribeDataSetPermissionsRequest,DescribeDataSetPermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes 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 \
describeDataSetPermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request)
AmazonQuickSightAsyncDescribes a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
AmazonQuickSightAsyncDescribes a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest request)
AmazonQuickSightAsyncDescribes the resource permissions for a data source.
The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSourcePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest request, AsyncHandler<DescribeDataSourcePermissionsRequest,DescribeDataSourcePermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes the resource permissions for a data source.
The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSourcePermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request)
AmazonQuickSightAsyncReturns 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
describeGroupAsync in interface AmazonQuickSightAsyncpublic Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
describeGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest request)
AmazonQuickSightAsyncDescribes 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
describeIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest request, AsyncHandler<DescribeIAMPolicyAssignmentRequest,DescribeIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncDescribes 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
describeIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest request)
AmazonQuickSightAsyncDescribes a SPICE ingestion.
describeIngestionAsync in interface AmazonQuickSightAsyncpublic Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest request, AsyncHandler<DescribeIngestionRequest,DescribeIngestionResult> asyncHandler)
AmazonQuickSightAsyncDescribes a SPICE ingestion.
describeIngestionAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest request)
AmazonQuickSightAsyncDescribes 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.
describeTemplateAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest request, AsyncHandler<DescribeTemplateRequest,DescribeTemplateResult> asyncHandler)
AmazonQuickSightAsyncDescribes 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.
describeTemplateAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest request)
AmazonQuickSightAsyncDescribes 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'
describeTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest request, AsyncHandler<DescribeTemplateAliasRequest,DescribeTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncDescribes 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'
describeTemplateAliasAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest request)
AmazonQuickSightAsyncDescribes read and write permissions on a template.
CLI syntax:
aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_template
describeTemplatePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest request, AsyncHandler<DescribeTemplatePermissionsRequest,DescribeTemplatePermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes read and write permissions on a template.
CLI syntax:
aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_template
describeTemplatePermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AmazonQuickSightAsyncReturns 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
describeUserAsync in interface AmazonQuickSightAsyncpublic Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
describeUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request)
AmazonQuickSightAsyncGenerates 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 user123@example.com --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
getDashboardEmbedUrlAsync in interface AmazonQuickSightAsyncpublic Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
AmazonQuickSightAsyncGenerates 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 user123@example.com --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
getDashboardEmbedUrlAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest request)
AmazonQuickSightAsyncLists 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
listDashboardVersionsAsync in interface AmazonQuickSightAsyncpublic Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest request, AsyncHandler<ListDashboardVersionsRequest,ListDashboardVersionsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listDashboardVersionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request)
AmazonQuickSightAsyncLists dashboards in the AWS account.
CLI syntax:
aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'
listDashboardsAsync in interface AmazonQuickSightAsyncpublic Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
AmazonQuickSightAsyncLists dashboards in the AWS account.
CLI syntax:
aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'
listDashboardsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest request)
AmazonQuickSightAsyncLists 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
listDataSetsAsync in interface AmazonQuickSightAsyncpublic Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest request, AsyncHandler<ListDataSetsRequest,ListDataSetsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listDataSetsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request)
AmazonQuickSightAsyncLists 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
listDataSourcesAsync in interface AmazonQuickSightAsyncpublic Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listDataSourcesAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request)
AmazonQuickSightAsyncLists 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
listGroupMembershipsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listGroupMembershipsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AmazonQuickSightAsyncLists 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
listGroupsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listGroupsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest request)
AmazonQuickSightAsyncLists 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
listIAMPolicyAssignmentsAsync in interface AmazonQuickSightAsyncpublic Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest request, AsyncHandler<ListIAMPolicyAssignmentsRequest,ListIAMPolicyAssignmentsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listIAMPolicyAssignmentsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest request)
AmazonQuickSightAsyncLists 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
listIAMPolicyAssignmentsForUserAsync in interface AmazonQuickSightAsyncpublic Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest request, AsyncHandler<ListIAMPolicyAssignmentsForUserRequest,ListIAMPolicyAssignmentsForUserResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listIAMPolicyAssignmentsForUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIngestionsResult> listIngestionsAsync(ListIngestionsRequest request)
AmazonQuickSightAsyncLists the history of SPICE ingestions for a dataset.
listIngestionsAsync in interface AmazonQuickSightAsyncpublic Future<ListIngestionsResult> listIngestionsAsync(ListIngestionsRequest request, AsyncHandler<ListIngestionsRequest,ListIngestionsResult> asyncHandler)
AmazonQuickSightAsyncLists the history of SPICE ingestions for a dataset.
listIngestionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonQuickSightAsyncLists 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
listTagsForResourceAsync in interface AmazonQuickSightAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listTagsForResourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTemplateAliasesResult> listTemplateAliasesAsync(ListTemplateAliasesRequest request)
AmazonQuickSightAsyncLists all the aliases of a template.
CLI syntax:
aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_template'
listTemplateAliasesAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplateAliasesResult> listTemplateAliasesAsync(ListTemplateAliasesRequest request, AsyncHandler<ListTemplateAliasesRequest,ListTemplateAliasesResult> asyncHandler)
AmazonQuickSightAsyncLists all the aliases of a template.
CLI syntax:
aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_template'
listTemplateAliasesAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTemplateVersionsResult> listTemplateVersionsAsync(ListTemplateVersionsRequest request)
AmazonQuickSightAsyncLists 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
listTemplateVersionsAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplateVersionsResult> listTemplateVersionsAsync(ListTemplateVersionsRequest request, AsyncHandler<ListTemplateVersionsRequest,ListTemplateVersionsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listTemplateVersionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest request)
AmazonQuickSightAsyncLists all the templates in the QuickSight account.
CLI syntax:
aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn
listTemplatesAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest request, AsyncHandler<ListTemplatesRequest,ListTemplatesResult> asyncHandler)
AmazonQuickSightAsyncLists all the templates in the QuickSight account.
CLI syntax:
aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn
listTemplatesAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request)
AmazonQuickSightAsyncLists 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
listUserGroupsAsync in interface AmazonQuickSightAsyncpublic Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest request, AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)
AmazonQuickSightAsyncLists 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
listUserGroupsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AmazonQuickSightAsyncReturns 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
listUsersAsync in interface AmazonQuickSightAsyncpublic Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AmazonQuickSightAsyncReturns 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
listUsersAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request)
AmazonQuickSightAsyncCreates 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=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
registerUserAsync in interface AmazonQuickSightAsyncpublic Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request, AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
AmazonQuickSightAsyncCreates 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=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
registerUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonQuickSightAsyncAssigns 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
tagResourceAsync in interface AmazonQuickSightAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonQuickSightAsyncAssigns 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
tagResourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonQuickSightAsyncRemoves 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
untagResourceAsync in interface AmazonQuickSightAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonQuickSightAsyncRemoves 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
untagResourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest request)
AmazonQuickSightAsyncUpdates 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
updateDashboardAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest request, AsyncHandler<UpdateDashboardRequest,UpdateDashboardResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateDashboardAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDashboardPermissionsResult> updateDashboardPermissionsAsync(UpdateDashboardPermissionsRequest request)
AmazonQuickSightAsyncUpdates 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": "user2@example.com", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }
updateDashboardPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardPermissionsResult> updateDashboardPermissionsAsync(UpdateDashboardPermissionsRequest request, AsyncHandler<UpdateDashboardPermissionsRequest,UpdateDashboardPermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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": "user2@example.com", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }
updateDashboardPermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDashboardPublishedVersionResult> updateDashboardPublishedVersionAsync(UpdateDashboardPublishedVersionRequest request)
AmazonQuickSightAsyncUpdates 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
updateDashboardPublishedVersionAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardPublishedVersionResult> updateDashboardPublishedVersionAsync(UpdateDashboardPublishedVersionRequest request, AsyncHandler<UpdateDashboardPublishedVersionRequest,UpdateDashboardPublishedVersionResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateDashboardPublishedVersionAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest request)
AmazonQuickSightAsyncUpdates 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"
}
]
}
}'
updateDataSetAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest request, AsyncHandler<UpdateDataSetRequest,UpdateDataSetResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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"
}
]
}
}'
updateDataSetAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataSetPermissionsResult> updateDataSetPermissionsAsync(UpdateDataSetPermissionsRequest request)
AmazonQuickSightAsyncUpdates 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"]}]'
updateDataSetPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSetPermissionsResult> updateDataSetPermissionsAsync(UpdateDataSetPermissionsRequest request, AsyncHandler<UpdateDataSetPermissionsRequest,UpdateDataSetPermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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"]}]'
updateDataSetPermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request)
AmazonQuickSightAsyncUpdates 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"}}
updateDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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"}}
updateDataSourceAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDataSourcePermissionsResult> updateDataSourcePermissionsAsync(UpdateDataSourcePermissionsRequest request)
AmazonQuickSightAsyncUpdates 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"]}]'
updateDataSourcePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSourcePermissionsResult> updateDataSourcePermissionsAsync(UpdateDataSourcePermissionsRequest request, AsyncHandler<UpdateDataSourcePermissionsRequest,UpdateDataSourcePermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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"]}]'
updateDataSourcePermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AmazonQuickSightAsyncChanges 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"
updateGroupAsync in interface AmazonQuickSightAsyncpublic Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AmazonQuickSightAsyncChanges 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"
updateGroupAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateIAMPolicyAssignmentResult> updateIAMPolicyAssignmentAsync(UpdateIAMPolicyAssignmentRequest request)
AmazonQuickSightAsyncUpdates 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
updateIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<UpdateIAMPolicyAssignmentResult> updateIAMPolicyAssignmentAsync(UpdateIAMPolicyAssignmentRequest request, AsyncHandler<UpdateIAMPolicyAssignmentRequest,UpdateIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest request)
AmazonQuickSightAsyncUpdates 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
updateTemplateAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest request, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateTemplateAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTemplateAliasResult> updateTemplateAliasAsync(UpdateTemplateAliasRequest request)
AmazonQuickSightAsyncUpdates 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
updateTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplateAliasResult> updateTemplateAliasAsync(UpdateTemplateAliasRequest request, AsyncHandler<UpdateTemplateAliasRequest,UpdateTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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
updateTemplateAliasAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTemplatePermissionsResult> updateTemplatePermissionsAsync(UpdateTemplatePermissionsRequest request)
AmazonQuickSightAsyncUpdates 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": "user2@example.com",
"Role": "ADMIN",
"UserName": "user2",
"PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"
},
"RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31",
"Status": 200
}
updateTemplatePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplatePermissionsResult> updateTemplatePermissionsAsync(UpdateTemplatePermissionsRequest request, AsyncHandler<UpdateTemplatePermissionsRequest,UpdateTemplatePermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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": "user2@example.com",
"Role": "ADMIN",
"UserName": "user2",
"PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"
},
"RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31",
"Status": 200
}
updateTemplatePermissionsAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AmazonQuickSightAsyncUpdates 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=new_address@example.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
updateUserAsync in interface AmazonQuickSightAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonQuickSightAsyncUpdates 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=new_address@example.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
updateUserAsync in interface AmazonQuickSightAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonQuickSightshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.