@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightClient extends AmazonWebServiceClient implements AmazonQuickSight
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_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonQuickSightClientBuilder builder()
public CancelIngestionResult cancelIngestion(CancelIngestionRequest request)
Cancels an on-going ingestion of data into SPICE.
cancelIngestion in interface AmazonQuickSightcancelIngestionRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.public CreateDashboardResult createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API.
A dashboard is an entity in QuickSight which identifies Quicksight reports, created from analyses. QuickSight
dashboards are sharable. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard and ListDashboardsByUser APIs act on
the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists
in a different AWS account.
CLI syntax:
aws quicksight create-dashboard --cli-input-json file://create-dashboard.json
createDashboard in interface AmazonQuickSightcreateDashboardRequest - ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.ConflictException - Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public CreateDataSetResult createDataSet(CreateDataSetRequest request)
Creates a dataset.
CLI syntax:
aws quicksight create-data-set \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--name='My dataset' \
--import-mode=SPICE \
--physical-table-map='{
"physical-table-id": {
"RelationalTable": {
"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
"Name": "table1",
"InputColumns": [
{
"Name": "column1",
"Type": "STRING"
}
]
}
}'
createDataSet in interface AmazonQuickSightcreateDataSetRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Creates a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight create-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--type=POSTGRESQL \
--data-source-parameters='{ "PostgreSqlParameters": {
"Host": "my-db-host.example.com",
"Port": 1234,
"Database": "my-db" } }' \
--credentials='{ "CredentialPair": {
"Username": "username",
"Password": "password" } }'
createDataSource in interface AmazonQuickSightcreateDataSourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.LimitExceededException - A limit is exceeded.ResourceNotFoundException - One or more resources can't be found.ResourceExistsException - The resource specified already exists.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public CreateGroupResult createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
CLI Sample:
aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
createGroup in interface AmazonQuickSightcreateGroupRequest - The request object for this operation.AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.LimitExceededException - A limit is exceeded.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
The response is the group member object.
CLI Sample:
aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
createGroupMembership in interface AmazonQuickSightcreateGroupMembershipRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy ARN and will assigned to specified groups or users of QuickSight. Users and groups need to be in the same namespace.
CLI syntax:
aws quicksight create-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=helpAssignment --policy-arn=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user5,engineer123,group=QS-Admin" --namespace=default --region=us-west-2
createIAMPolicyAssignment in interface AmazonQuickSightcreateIAMPolicyAssignmentRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in an "actionable" state that must complete before a new update can be applied.InternalFailureException - An internal failure occurred.public CreateIngestionResult createIngestion(CreateIngestionRequest request)
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access-control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags?. Tags will be visible on the tagged dataset, but not on the ingestion resource.
createIngestion in interface AmazonQuickSightcreateIngestionRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.public CreateTemplateResult createTemplate(CreateTemplateRequest request)
Creates a template from an existing QuickSight analysis or template. The resulting template can be used to create a dashboard.
A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be used to create dashboard. It adds a layer of abstraction by use placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets which follow the same schema that was used to create the source analysis and template.
To create a template from an existing analysis, use the analysis's ARN, aws-account-id,
template-id, source-entity, and data-set-references.
CLI syntax to create a template:
aws quicksight create-template —cli-input-json file://create-template.json
CLI syntax to create a template from another template in the same AWS account:
aws quicksight create-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0dfc789c-81f6-4f4f-b9ac-7db2453eefc8 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/f60da323-af68-45db-9016-08e0d1d7ded5 --source-entity SourceAnalysis='{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/7fb74527-c36d-4be8-8139-ac1be4c97365}'
To create template from another account’s template, you need to grant cross account resource permission for DescribeTemplate the account that contains the template.
You can use a file to pass JSON to the function if you prefer.
createTemplate in interface AmazonQuickSightcreateTemplateRequest - InvalidParameterValueException - One or more parameters don't have a valid value.AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
Creates a template alias for a template.
CLI syntax:
aws quicksight create-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name PROD —version-number 1
createTemplateAlias in interface AmazonQuickSightcreateTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceExistsException - The resource specified already exists.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
CLI syntax:
aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123
aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123 —version-number 3
deleteDashboard in interface AmazonQuickSightdeleteDashboardRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
CLI syntax:
aws quicksight delete-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
deleteDataSet in interface AmazonQuickSightdeleteDataSetRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
CLI syntax:
aws quicksight delete-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id
deleteDataSource in interface AmazonQuickSightdeleteDataSourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
CLI Sample:
aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
deleteGroup in interface AmazonQuickSightdeleteGroupRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
CLI Sample:
aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
deleteGroupMembership in interface AmazonQuickSightdeleteGroupMembershipRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing assignment.
CLI syntax:
aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default
deleteIAMPolicyAssignment in interface AmazonQuickSightdeleteIAMPolicyAssignmentRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in an "actionable" state that must complete before a new update can be applied.InternalFailureException - An internal failure occurred.public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
Deletes a template.
CLI syntax:
aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template --version-number 2
aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name STAGING
aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name ‘\$LATEST’
aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template
If version number which is an optional field is not passed the template (including all the versions) is deleted by the API, if version number is provided, the specific template version is deleted by the API.
Users can explicitly describe the latest version of the template by passing $LATEST to the
alias-name parameter. $LATEST is an internally supported alias, which points to the
latest version of the template.
deleteTemplate in interface AmazonQuickSightdeleteTemplateRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
Update template alias of given template.
CLI syntax:
aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
deleteTemplateAlias in interface AmazonQuickSightdeleteTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. 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
deleteUser in interface AmazonQuickSightdeleteUserRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
CLI Sample:
aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
deleteUserByPrincipalId in interface AmazonQuickSightdeleteUserByPrincipalIdRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
CLI syntax:
aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -version-number 2
aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -alias-name ‘$PUBLISHED’
describeDashboard in interface AmazonQuickSightdescribeDashboardRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions on a dashboard.
CLI syntax:
aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report
describeDashboardPermissions in interface AmazonQuickSightdescribeDashboardPermissionsRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
Describes a dataset.
CLI syntax:
aws quicksight describe-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
describeDataSet in interface AmazonQuickSightdescribeDataSetRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
CLI syntax:
aws quicksight describe-data-set-permissions \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
describeDataSetPermissions in interface AmazonQuickSightdescribeDataSetPermissionsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSource in interface AmazonQuickSightdescribeDataSourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id
describeDataSourcePermissions in interface AmazonQuickSightdescribeDataSourcePermissionsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is the group object.
CLI Sample:
aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
describeGroup in interface AmazonQuickSightdescribeGroupRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAMPolicy Assignment by specified assignment name.
CLI syntax:
aws quicksight describe-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --namespace=default --region=us-east-1
describeIAMPolicyAssignment in interface AmazonQuickSightdescribeIAMPolicyAssignmentRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.public DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
describeIngestion in interface AmazonQuickSightdescribeIngestionRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InternalFailureException - An internal failure occurred.public DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
Describes a template's metadata.
CLI syntax:
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --version-number-2
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --alias-name '\$LATEST'
Users can explicitly describe the latest version of the dashboard by passing $LATEST to the
alias-name parameter. $LATEST is an internally supported alias, which points to the
latest version of the dashboard.
describeTemplate in interface AmazonQuickSightdescribeTemplateRequest - InvalidParameterValueException - One or more parameters don't have a valid value.AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
Describes the template aliases of a template.
CLI syntax:
aws quicksight describe-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
describeTemplateAlias in interface AmazonQuickSightdescribeTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
Describes read and write permissions on a template.
CLI syntax:
aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_template
describeTemplatePermissions in interface AmazonQuickSightdescribeTemplatePermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public DescribeUserResult describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
describeUser in interface AmazonQuickSightdescribeUserRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
CLI Sample:
Assume the role with permissions enabled for actions: quickSight:RegisterUser and
quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or
assume-role-with-saml.
aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
If the user does not exist in QuickSight, register the user:
aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email 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
getDashboardEmbedUrl in interface AmazonQuickSightgetDashboardEmbedUrlRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.DomainNotWhitelistedException - The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException - The user is not found. This error can happen in any operation that requires finding a user based on a
provided user name, such as DeleteUser, DescribeUser, and so on.IdentityTypeNotSupportedException - The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be
from 15 to 600 minutes.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the Quicksight subscription.
CLI syntax:
aws quicksight list-template-versions —aws-account-id 111122223333 —template-id reports-test-template
listDashboardVersions in interface AmazonQuickSightlistDashboardVersionsRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListDashboardsResult listDashboards(ListDashboardsRequest request)
Lists dashboards in the AWS account.
CLI syntax:
aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'
listDashboards in interface AmazonQuickSightlistDashboardsRequest - ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListDataSetsResult listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to this account in an AWS region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
CLI syntax: aws quicksight list-data-sets --aws-account-id=111111111111
listDataSets in interface AmazonQuickSightlistDataSetsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists data sources in current AWS region that belong to this AWS account.
The permissions resource is: arn:aws:quicksight:region:aws-account-id:datasource/*
CLI syntax: aws quicksight list-data-sources --aws-account-id=111122223333
listDataSources in interface AmazonQuickSightlistDataSourcesRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a list of group member objects.
CLI Sample:
aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
listGroupMemberships in interface AmazonQuickSightlistGroupMembershipsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public ListGroupsResult listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
The response is a list of group objects.
CLI Sample:
aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
listGroups in interface AmazonQuickSightlistGroupsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists assignments in current QuickSight account.
CLI syntax:
aws quicksight list-iam-policy-assignments --aws-account-id=111122223333 --max-result=5 --assignment-status=ENABLED --namespace=default --region=us-east-1 --next-token=3
listIAMPolicyAssignments in interface AmazonQuickSightlistIAMPolicyAssignmentsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all the assignments and the ARNs for the associated IAM policies assigned to the specified user and the group or groups that the user belongs to.
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
listIAMPolicyAssignmentsForUser in interface AmazonQuickSightlistIAMPolicyAssignmentsForUserRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in an "actionable" state that must complete before a new update can be applied.InternalFailureException - An internal failure occurred.public ListIngestionsResult listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
listIngestions in interface AmazonQuickSightlistIngestionsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
CLI syntax:
aws quicksight list-tags-for-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --region us-east-1
listTagsForResource in interface AmazonQuickSightlistTagsForResourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
Lists all the aliases of a template.
CLI syntax:
aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_template'
listTemplateAliases in interface AmazonQuickSightlistTemplateAliasesRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
Lists all the versions of the templates in the Quicksight account.
CLI syntax:
aws quicksight list-template-versions --aws-account-id 111122223333 --aws-account-id 196359894473 --template-id reports-test-template
listTemplateVersions in interface AmazonQuickSightlistTemplateVersionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListTemplatesResult listTemplates(ListTemplatesRequest request)
Lists all the templates in the QuickSight account.
CLI syntax:
aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn
listTemplates in interface AmazonQuickSightlistTemplatesRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.InvalidNextTokenException - The NextToken value isn't valid.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
The response is a one or more group objects.
CLI Sample:
aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
listUserGroups in interface AmazonQuickSightlistUserGroupsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public ListUsersResult listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight list-users --aws-account-id=111122223333 --namespace=default
listUsers in interface AmazonQuickSightlistUsersRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InvalidNextTokenException - The NextToken value isn't valid.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public RegisterUserResult registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
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
registerUser in interface AmazonQuickSightregisterUserRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.ResourceExistsException - The resource specified already exists.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public TagResourceResult tagResource(TagResourceRequest request)
Assigns a tag or tags to a resource.
Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data-set, data-source, dashboard, template.
Tagging for QuickSight works in a similar was to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight, because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
CLI syntax to tag a resource:
aws quicksight tag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tags Key=K1,Value=V1 Key=K2,Value=V2 --region us-east-1
tagResource in interface AmazonQuickSighttagResourceRequest - LimitExceededException - A limit is exceeded.AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
CLI syntax:
aws quicksight untag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tag-keys K1 K2 --region us-east-1
untagResource in interface AmazonQuickSightuntagResourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
Updates a dashboard in the AWS account.
CLI syntax:
aws quicksight update-dashboard --aws-account-id 111122223333 --dashboard-id 123123123 --dashboard-name "test-update102" --source-entity SourceTemplate={Arn=arn:aws:quicksight:us-west-2:111122223333:template/sales-report-template2} --data-set-references DataSetPlaceholder=SalesDataSet,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0e251aef-9ebf-46e1-b852-eb4fa33c1d3a
aws quicksight update-dashboard --cli-input-json file://update-dashboard.json
updateDashboard in interface AmazonQuickSightupdateDashboardRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
CLI syntax:
aws quicksight update-dashboard-permissions —cli-input-json file://update-permission.json
A sample update-permissions.json for granting read only permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard" ] } ] }
A sample update-permissions.json for granting read and write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
A sample update-permissions.json for revoking write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
A sample update-permissions.json for revoking read and write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
To obtain the principal name of a QuickSight user or group, you can use describe-group or describe-user. For example:
aws quicksight describe-user --aws-account-id 111122223333 --namespace default --user-name user2 --region us-east-1 { "User": { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Active": true, "Email": "user2@example.com", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }
updateDashboardPermissions in interface AmazonQuickSightupdateDashboardPermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.public UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
CLI syntax:
aws quicksight update-dashboard-published-version --aws-account-id 111122223333 --dashboard-id dashboard-w1 ---version-number 2
updateDashboardPublishedVersion in interface AmazonQuickSightupdateDashboardPublishedVersionRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
Updates a dataset.
CLI syntax:
aws quicksight update-data-set \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--name='My dataset' \
--import-mode=SPICE \
--physical-table-map='{
"physical-table-id": {
"RelationalTable": {
"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
"Name": "table1",
"InputColumns": [
{
"Name": "column1",
"Type": "STRING"
}
]
}
}'
updateDataSet in interface AmazonQuickSightupdateDataSetRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.LimitExceededException - A limit is exceeded.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
CLI syntax:
aws quicksight update-data-set-permissions \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSet","quicksight:DescribeDataSetPermissions","quicksight:PassDataSet","quicksight:ListIngestions","quicksight:DescribeIngestion"]}]' \
--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSet","quicksight:DeleteDataSet","quicksight:UpdateDataSetPermissions","quicksight:CreateIngestion","quicksight:CancelIngestion"]}]'
updateDataSetPermissions in interface AmazonQuickSightupdateDataSetPermissionsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight update-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--data-source-parameters='{"PostgreSqlParameters":{"Host":"my-db-host.example.com","Port":1234,"Database":"my-db"}}' \
--credentials='{"CredentialPair":{"Username":"username","Password":"password"}}
updateDataSource in interface AmazonQuickSightupdateDataSourceRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.InternalFailureException - An internal failure occurred.public UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight update-data-source-permissions \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSource","quicksight:DescribeDataSourcePermissions","quicksight:PassDataSource"]}]' \
--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSource","quicksight:DeleteDataSource","quicksight:UpdateDataSourcePermissions"]}]'
updateDataSourcePermissions in interface AmazonQuickSightupdateDataSourcePermissionsRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
Changes a group description.
The permissions resource is
arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a group object.
CLI Sample:
aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
updateGroup in interface AmazonQuickSightupdateGroupRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing assignment. This operation updates only the optional parameter or parameters that are specified in the request.
CLI syntax:
aws quicksight update-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=FullAccessAssignment --assignment-status=DRAFT --policy-arns=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user-1,user-2,group=admin" --namespace=default --region=us-east-1
updateIAMPolicyAssignment in interface AmazonQuickSightupdateIAMPolicyAssignmentRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConcurrentUpdatingException - A resource is already in an "actionable" state that must complete before a new update can be applied.InternalFailureException - An internal failure occurred.public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing QuickSight analysis.
CLI syntax:
aws quicksight update-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/c684a204-d134-4c53-a63c-451f72c60c28 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/15840b7d-b542-4491-937b-602416b367b3 —source-entity SourceAnalysis=’{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/c5731fe9-4708-4598-8f6d-cf2a70875b6d}
You can also pass in a json file:
aws quicksight update-template —cli-input-json file://create-template.json
updateTemplate in interface AmazonQuickSightupdateTemplateRequest - InvalidParameterValueException - One or more parameters don't have a valid value.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.ConflictException - Updating or deleting a resource can cause an inconsistent state.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
CLI syntax:
aws quicksight update-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name STAGING —template-version-number 2
updateTemplateAlias in interface AmazonQuickSightupdateTemplateAliasRequest - ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the permissions on a template.
CLI syntax:
aws quicksight describe-template-permissions —aws-account-id 111122223333 —template-id reports_test_template
aws quicksight update-template-permissions —cli-input-json file://update-permission.json
The structure of update-permissions.json to add permissions:
{ "AwsAccountId": "111122223333",
"DashboardId": "reports_test_template",
"GrantPermissions": [
{ "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",
"Actions": [
"quicksight:DescribeTemplate",
"quicksight:ListTemplateVersions"
] } ] }
The structure of update-permissions.json to add permissions:
{ "AwsAccountId": "111122223333",
"DashboardId": "reports_test_template",
"RevokePermissions": [
{ "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",
"Actions": [
"quicksight:DescribeTemplate",
"quicksight:ListTemplateVersions"
] } ] }
To obtain the principal name of a QuickSight group or user, use user describe-group or describe-user. For example:
aws quicksight describe-user
--aws-account-id 111122223333
--namespace default
--user-name user2
--region us-east-1
{
"User": {
"Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
"Active": true,
"Email": "user2@example.com",
"Role": "ADMIN",
"UserName": "user2",
"PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"
},
"RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31",
"Status": 200
}
updateTemplatePermissions in interface AmazonQuickSightupdateTemplatePermissionsRequest - ThrottlingException - Access is throttled.InvalidParameterValueException - One or more parameters don't have a valid value.ConflictException - Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).
CLI Sample:
aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@example.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
updateUser in interface AmazonQuickSightupdateUserRequest - AccessDeniedException - You don't have access to this. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
service, that your policies have the correct permissions, and that you are using the correct access keys.InvalidParameterValueException - One or more parameters don't have a valid value.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonQuickSightrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.