@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 business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, cancelIngestion, createAccountCustomization, createAnalysis, createDashboard, createDataSet, createDataSource, createFolder, createFolderMembership, createGroup, createGroupMembership, createIAMPolicyAssignment, createIngestion, createNamespace, createTemplate, createTemplateAlias, createTheme, createThemeAlias, deleteAccountCustomization, deleteAnalysis, deleteDashboard, deleteDataSet, deleteDataSource, deleteFolder, deleteFolderMembership, deleteGroup, deleteGroupMembership, deleteIAMPolicyAssignment, deleteNamespace, deleteTemplate, deleteTemplateAlias, deleteTheme, deleteThemeAlias, deleteUser, deleteUserByPrincipalId, describeAccountCustomization, describeAccountSettings, describeAnalysis, describeAnalysisPermissions, describeDashboard, describeDashboardPermissions, describeDataSet, describeDataSetPermissions, describeDataSource, describeDataSourcePermissions, describeFolder, describeFolderPermissions, describeFolderResolvedPermissions, describeGroup, describeGroupMembership, describeIAMPolicyAssignment, describeIngestion, describeIpRestriction, describeNamespace, describeTemplate, describeTemplateAlias, describeTemplatePermissions, describeTheme, describeThemeAlias, describeThemePermissions, describeUser, generateEmbedUrlForAnonymousUser, generateEmbedUrlForRegisteredUser, getCachedResponseMetadata, getDashboardEmbedUrl, getSessionEmbedUrl, listAnalyses, listDashboards, listDashboardVersions, listDataSets, listDataSources, listFolderMembers, listFolders, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listNamespaces, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listThemeAliases, listThemes, listThemeVersions, listUserGroups, listUsers, registerUser, restoreAnalysis, searchAnalyses, searchDashboards, searchFolders, searchGroups, tagResource, untagResource, updateAccountCustomization, updateAccountSettings, updateAnalysis, updateAnalysisPermissions, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateFolder, updateFolderPermissions, updateGroup, updateIAMPolicyAssignment, updateIpRestriction, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateTheme, updateThemeAlias, updateThemePermissions, 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, createAccountCustomization, createAnalysis, createDashboard, createDataSet, createDataSource, createFolder, createFolderMembership, createGroup, createGroupMembership, createIAMPolicyAssignment, createIngestion, createNamespace, createTemplate, createTemplateAlias, createTheme, createThemeAlias, deleteAccountCustomization, deleteAnalysis, deleteDashboard, deleteDataSet, deleteDataSource, deleteFolder, deleteFolderMembership, deleteGroup, deleteGroupMembership, deleteIAMPolicyAssignment, deleteNamespace, deleteTemplate, deleteTemplateAlias, deleteTheme, deleteThemeAlias, deleteUser, deleteUserByPrincipalId, describeAccountCustomization, describeAccountSettings, describeAnalysis, describeAnalysisPermissions, describeDashboard, describeDashboardPermissions, describeDataSet, describeDataSetPermissions, describeDataSource, describeDataSourcePermissions, describeFolder, describeFolderPermissions, describeFolderResolvedPermissions, describeGroup, describeGroupMembership, describeIAMPolicyAssignment, describeIngestion, describeIpRestriction, describeNamespace, describeTemplate, describeTemplateAlias, describeTemplatePermissions, describeTheme, describeThemeAlias, describeThemePermissions, describeUser, generateEmbedUrlForAnonymousUser, generateEmbedUrlForRegisteredUser, getCachedResponseMetadata, getDashboardEmbedUrl, getSessionEmbedUrl, listAnalyses, listDashboards, listDashboardVersions, listDataSets, listDataSources, listFolderMembers, listFolders, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listNamespaces, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listThemeAliases, listThemes, listThemeVersions, listUserGroups, listUsers, registerUser, restoreAnalysis, searchAnalyses, searchDashboards, searchFolders, searchGroups, tagResource, untagResource, updateAccountCustomization, updateAccountSettings, updateAnalysis, updateAnalysisPermissions, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateFolder, updateFolderPermissions, updateGroup, updateIAMPolicyAssignment, updateIpRestriction, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateTheme, updateThemeAlias, updateThemePermissions, updateUserpublic static AmazonQuickSightAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request)
AmazonQuickSightAsyncCancels an ongoing ingestion of data into SPICE.
cancelIngestionAsync in interface AmazonQuickSightAsyncpublic Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request, AsyncHandler<CancelIngestionRequest,CancelIngestionResult> asyncHandler)
AmazonQuickSightAsyncCancels an ongoing 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<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest request)
AmazonQuickSightAsync
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom
default theme by using the CreateAccountCustomization or UpdateAccountCustomization API
operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all
new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the
DescribeThemePermissions
API operation. To share the theme, grant permissions by using the
UpdateThemePermissions
API operation.
createAccountCustomizationAsync in interface AmazonQuickSightAsyncpublic Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest request, AsyncHandler<CreateAccountCustomizationRequest,CreateAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsync
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom
default theme by using the CreateAccountCustomization or UpdateAccountCustomization API
operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all
new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the
DescribeThemePermissions
API operation. To share the theme, grant permissions by using the
UpdateThemePermissions
API operation.
createAccountCustomizationAsync 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<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest request)
AmazonQuickSightAsyncCreates an analysis in Amazon QuickSight.
createAnalysisAsync in interface AmazonQuickSightAsyncpublic Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest request, AsyncHandler<CreateAnalysisRequest,CreateAnalysisResult> asyncHandler)
AmazonQuickSightAsyncCreates an analysis in Amazon QuickSight.
createAnalysisAsync 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)
AmazonQuickSightAsync
Creates a dashboard from a template. To first create a template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
createDashboardAsync in interface AmazonQuickSightAsyncpublic Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest request, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
AmazonQuickSightAsync
Creates a dashboard from a template. To first create a template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
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. This operation doesn't support datasets that include uploaded files as a source.
createDataSetAsync in interface AmazonQuickSightAsyncpublic Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest request, AsyncHandler<CreateDataSetRequest,CreateDataSetResult> asyncHandler)
AmazonQuickSightAsyncCreates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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.
createDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
AmazonQuickSightAsyncCreates a data source.
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<CreateFolderResult> createFolderAsync(CreateFolderRequest request)
AmazonQuickSightAsyncCreates an empty shared folder.
createFolderAsync in interface AmazonQuickSightAsyncpublic Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
AmazonQuickSightAsyncCreates an empty shared folder.
createFolderAsync 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<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest request)
AmazonQuickSightAsyncAdds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipAsync in interface AmazonQuickSightAsyncpublic Future<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest request, AsyncHandler<CreateFolderMembershipRequest,CreateFolderMembershipResult> asyncHandler)
AmazonQuickSightAsyncAdds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipAsync 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:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
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:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
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.
createGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
AmazonQuickSightAsyncAdds an Amazon QuickSight user to an Amazon QuickSight group.
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, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
createIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest request, AsyncHandler<CreateIAMPolicyAssignmentRequest,CreateIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncCreates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionAsync in interface AmazonQuickSightAsyncpublic Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest request, AsyncHandler<CreateIngestionRequest,CreateIngestionResult> asyncHandler)
AmazonQuickSightAsyncCreates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
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<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest request)
AmazonQuickSightAsync(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
createNamespaceAsync in interface AmazonQuickSightAsyncpublic Future<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest request, AsyncHandler<CreateNamespaceRequest,CreateNamespaceResult> asyncHandler)
AmazonQuickSightAsync(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
createNamespaceAsync 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 Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateAsync in interface AmazonQuickSightAsyncpublic Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
AmazonQuickSightAsyncCreates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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.
createTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest request, AsyncHandler<CreateTemplateAliasRequest,CreateTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncCreates a template alias for a template.
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<CreateThemeResult> createThemeAsync(CreateThemeRequest request)
AmazonQuickSightAsyncCreates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
createThemeAsync in interface AmazonQuickSightAsyncpublic Future<CreateThemeResult> createThemeAsync(CreateThemeRequest request, AsyncHandler<CreateThemeRequest,CreateThemeResult> asyncHandler)
AmazonQuickSightAsyncCreates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
createThemeAsync 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<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest request)
AmazonQuickSightAsyncCreates a theme alias for a theme.
createThemeAliasAsync in interface AmazonQuickSightAsyncpublic Future<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest request, AsyncHandler<CreateThemeAliasRequest,CreateThemeAliasResult> asyncHandler)
AmazonQuickSightAsyncCreates a theme alias for a theme.
createThemeAliasAsync 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<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest request)
AmazonQuickSightAsyncDeletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomizationAsync in interface AmazonQuickSightAsyncpublic Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest request, AsyncHandler<DeleteAccountCustomizationRequest,DeleteAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsyncDeletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomizationAsync 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<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest request)
AmazonQuickSightAsync
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon
QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the
DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisAsync in interface AmazonQuickSightAsyncpublic Future<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest request, AsyncHandler<DeleteAnalysisRequest,DeleteAnalysisResult> asyncHandler)
AmazonQuickSightAsync
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon
QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the
DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisAsync 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.
deleteDashboardAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest request, AsyncHandler<DeleteDashboardRequest,DeleteDashboardResult> asyncHandler)
AmazonQuickSightAsyncDeletes a dashboard.
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.
deleteDataSetAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest request, AsyncHandler<DeleteDataSetRequest,DeleteDataSetResult> asyncHandler)
AmazonQuickSightAsyncDeletes a dataset.
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 operation breaks all the datasets that reference the deleted data source.
deleteDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
AmazonQuickSightAsyncDeletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
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<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request)
AmazonQuickSightAsyncDeletes an empty folder.
deleteFolderAsync in interface AmazonQuickSightAsyncpublic Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
AmazonQuickSightAsyncDeletes an empty folder.
deleteFolderAsync 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<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest request)
AmazonQuickSightAsyncRemoves an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipAsync in interface AmazonQuickSightAsyncpublic Future<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest request, AsyncHandler<DeleteFolderMembershipRequest,DeleteFolderMembershipResult> asyncHandler)
AmazonQuickSightAsyncRemoves an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipAsync 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.
deleteGroupAsync in interface AmazonQuickSightAsyncpublic Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AmazonQuickSightAsyncRemoves a user group from Amazon QuickSight.
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.
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.
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 IAM policy assignment.
deleteIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest request, AsyncHandler<DeleteIAMPolicyAssignmentRequest,DeleteIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncDeletes an existing IAM policy assignment.
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<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest request)
AmazonQuickSightAsyncDeletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
deleteNamespaceAsync in interface AmazonQuickSightAsyncpublic Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest request, AsyncHandler<DeleteNamespaceRequest,DeleteNamespaceResult> asyncHandler)
AmazonQuickSightAsyncDeletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
deleteNamespaceAsync 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.
deleteTemplateAsync in interface AmazonQuickSightAsyncpublic Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
AmazonQuickSightAsyncDeletes a 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)
AmazonQuickSightAsyncDeletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest request, AsyncHandler<DeleteTemplateAliasRequest,DeleteTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncDeletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
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<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest request)
AmazonQuickSightAsyncDeletes a theme.
deleteThemeAsync in interface AmazonQuickSightAsyncpublic Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest request, AsyncHandler<DeleteThemeRequest,DeleteThemeResult> asyncHandler)
AmazonQuickSightAsyncDeletes a theme.
deleteThemeAsync 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<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest request)
AmazonQuickSightAsyncDeletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
deleteThemeAliasAsync in interface AmazonQuickSightAsyncpublic Future<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest request, AsyncHandler<DeleteThemeAliasRequest,DeleteThemeAliasResult> asyncHandler)
AmazonQuickSightAsyncDeletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
deleteThemeAliasAsync 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 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.
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 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.
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.
deleteUserByPrincipalIdAsync in interface AmazonQuickSightAsyncpublic Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
AmazonQuickSightAsyncDeletes a user identified by its principal ID.
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<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest request)
AmazonQuickSightAsync
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the
same customizations.
describeAccountCustomizationAsync in interface AmazonQuickSightAsyncpublic Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest request, AsyncHandler<DescribeAccountCustomizationRequest,DescribeAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsync
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the
same customizations.
describeAccountCustomizationAsync 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<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest request)
AmazonQuickSightAsyncDescribes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettingsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest request, AsyncHandler<DescribeAccountSettingsRequest,DescribeAccountSettingsResult> asyncHandler)
AmazonQuickSightAsyncDescribes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettingsAsync 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<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest request)
AmazonQuickSightAsyncProvides a summary of the metadata for an analysis.
describeAnalysisAsync in interface AmazonQuickSightAsyncpublic Future<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest request, AsyncHandler<DescribeAnalysisRequest,DescribeAnalysisResult> asyncHandler)
AmazonQuickSightAsyncProvides a summary of the metadata for an analysis.
describeAnalysisAsync 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<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest request)
AmazonQuickSightAsyncProvides the read and write permissions for an analysis.
describeAnalysisPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest request, AsyncHandler<DescribeAnalysisPermissionsRequest,DescribeAnalysisPermissionsResult> asyncHandler)
AmazonQuickSightAsyncProvides the read and write permissions for an analysis.
describeAnalysisPermissionsAsync 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.
describeDashboardAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest request, AsyncHandler<DescribeDashboardRequest,DescribeDashboardResult> asyncHandler)
AmazonQuickSightAsyncProvides a summary for a dashboard.
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 for a dashboard.
describeDashboardPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest request, AsyncHandler<DescribeDashboardPermissionsRequest,DescribeDashboardPermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes read and write permissions for a dashboard.
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. This operation doesn't support datasets that include uploaded files as a source.
describeDataSetAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest request, AsyncHandler<DescribeDataSetRequest,DescribeDataSetResult> asyncHandler)
AmazonQuickSightAsyncDescribes a dataset. This operation doesn't support datasets that include uploaded files as a source.
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.
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.
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.
describeDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
AmazonQuickSightAsyncDescribes a data source.
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.
describeDataSourcePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest request, AsyncHandler<DescribeDataSourcePermissionsRequest,DescribeDataSourcePermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes the resource permissions for a data source.
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<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest request)
AmazonQuickSightAsyncDescribes a folder.
describeFolderAsync in interface AmazonQuickSightAsyncpublic Future<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest request, AsyncHandler<DescribeFolderRequest,DescribeFolderResult> asyncHandler)
AmazonQuickSightAsyncDescribes a folder.
describeFolderAsync 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<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest request)
AmazonQuickSightAsyncDescribes permissions for a folder.
describeFolderPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest request, AsyncHandler<DescribeFolderPermissionsRequest,DescribeFolderPermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes permissions for a folder.
describeFolderPermissionsAsync 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<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest request)
AmazonQuickSightAsyncDescribes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest request, AsyncHandler<DescribeFolderResolvedPermissionsRequest,DescribeFolderResolvedPermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsAsync 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).
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).
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<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest request)
AmazonQuickSightAsync
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember object is
returned.
describeGroupMembershipAsync in interface AmazonQuickSightAsyncpublic Future<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest request, AsyncHandler<DescribeGroupMembershipRequest,DescribeGroupMembershipResult> asyncHandler)
AmazonQuickSightAsync
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember object is
returned.
describeGroupMembershipAsync 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 IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest request, AsyncHandler<DescribeIAMPolicyAssignmentRequest,DescribeIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsyncDescribes an existing IAM policy assignment, as specified by the assignment name.
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<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest request)
AmazonQuickSightAsyncProvides a summary and status of IP rules.
describeIpRestrictionAsync in interface AmazonQuickSightAsyncpublic Future<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest request, AsyncHandler<DescribeIpRestrictionRequest,DescribeIpRestrictionResult> asyncHandler)
AmazonQuickSightAsyncProvides a summary and status of IP rules.
describeIpRestrictionAsync 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<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest request)
AmazonQuickSightAsyncDescribes the current namespace.
describeNamespaceAsync in interface AmazonQuickSightAsyncpublic Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest request, AsyncHandler<DescribeNamespaceRequest,DescribeNamespaceResult> asyncHandler)
AmazonQuickSightAsyncDescribes the current namespace.
describeNamespaceAsync 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.
describeTemplateAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest request, AsyncHandler<DescribeTemplateRequest,DescribeTemplateResult> asyncHandler)
AmazonQuickSightAsyncDescribes a template's metadata.
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 alias for a template.
describeTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest request, AsyncHandler<DescribeTemplateAliasRequest,DescribeTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncDescribes the template alias for a template.
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.
describeTemplatePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest request, AsyncHandler<DescribeTemplatePermissionsRequest,DescribeTemplatePermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes read and write permissions on a 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<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest request)
AmazonQuickSightAsyncDescribes a theme.
describeThemeAsync in interface AmazonQuickSightAsyncpublic Future<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest request, AsyncHandler<DescribeThemeRequest,DescribeThemeResult> asyncHandler)
AmazonQuickSightAsyncDescribes a theme.
describeThemeAsync 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<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest request)
AmazonQuickSightAsyncDescribes the alias for a theme.
describeThemeAliasAsync in interface AmazonQuickSightAsyncpublic Future<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest request, AsyncHandler<DescribeThemeAliasRequest,DescribeThemeAliasResult> asyncHandler)
AmazonQuickSightAsyncDescribes the alias for a theme.
describeThemeAliasAsync 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<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest request)
AmazonQuickSightAsyncDescribes the read and write permissions for a theme.
describeThemePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest request, AsyncHandler<DescribeThemePermissionsRequest,DescribeThemePermissionsResult> asyncHandler)
AmazonQuickSightAsyncDescribes the read and write permissions for a theme.
describeThemePermissionsAsync 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.
describeUserAsync in interface AmazonQuickSightAsyncpublic Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonQuickSightAsyncReturns information about a user, given the user name.
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<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest request)
AmazonQuickSightAsyncGenerates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserAsync in interface AmazonQuickSightAsyncpublic Future<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest request, AsyncHandler<GenerateEmbedUrlForAnonymousUserRequest,GenerateEmbedUrlForAnonymousUserResult> asyncHandler)
AmazonQuickSightAsyncGenerates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserAsync 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<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest request)
AmazonQuickSightAsyncGenerates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserAsync in interface AmazonQuickSightAsyncpublic Future<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest request, AsyncHandler<GenerateEmbedUrlForRegisteredUserRequest,GenerateEmbedUrlForRegisteredUserResult> asyncHandler)
AmazonQuickSightAsyncGenerates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserAsync 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 session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
getDashboardEmbedUrlAsync in interface AmazonQuickSightAsyncpublic Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
AmazonQuickSightAsyncGenerates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest request)
AmazonQuickSightAsync
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlAsync in interface AmazonQuickSightAsyncpublic Future<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest request, AsyncHandler<GetSessionEmbedUrlRequest,GetSessionEmbedUrlResult> asyncHandler)
AmazonQuickSightAsync
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlAsync 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<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest request)
AmazonQuickSightAsyncLists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalysesAsync in interface AmazonQuickSightAsyncpublic Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest request, AsyncHandler<ListAnalysesRequest,ListAnalysesResult> asyncHandler)
AmazonQuickSightAsyncLists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalysesAsync 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 Amazon QuickSight subscription.
listDashboardVersionsAsync in interface AmazonQuickSightAsyncpublic Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest request, AsyncHandler<ListDashboardVersionsRequest,ListDashboardVersionsResult> asyncHandler)
AmazonQuickSightAsyncLists all the versions of the dashboards in the Amazon QuickSight subscription.
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 an Amazon Web Services account.
listDashboardsAsync in interface AmazonQuickSightAsyncpublic Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
AmazonQuickSightAsyncLists dashboards in an Amazon Web Services account.
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 the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSetsAsync in interface AmazonQuickSightAsyncpublic Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest request, AsyncHandler<ListDataSetsRequest,ListDataSetsResult> asyncHandler)
AmazonQuickSightAsyncLists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
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 Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSourcesAsync in interface AmazonQuickSightAsyncpublic Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AmazonQuickSightAsyncLists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
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<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest request)
AmazonQuickSightAsync
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolderMembersAsync in interface AmazonQuickSightAsyncpublic Future<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest request, AsyncHandler<ListFolderMembersRequest,ListFolderMembersResult> asyncHandler)
AmazonQuickSightAsync
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolderMembersAsync 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<ListFoldersResult> listFoldersAsync(ListFoldersRequest request)
AmazonQuickSightAsyncLists all folders in an account.
listFoldersAsync in interface AmazonQuickSightAsyncpublic Future<ListFoldersResult> listFoldersAsync(ListFoldersRequest request, AsyncHandler<ListFoldersRequest,ListFoldersResult> asyncHandler)
AmazonQuickSightAsyncLists all folders in an account.
listFoldersAsync 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.
listGroupMembershipsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
AmazonQuickSightAsyncLists member users in a group.
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.
listGroupsAsync in interface AmazonQuickSightAsyncpublic Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AmazonQuickSightAsyncLists all user groups in Amazon QuickSight.
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 IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsAsync in interface AmazonQuickSightAsyncpublic Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest request, AsyncHandler<ListIAMPolicyAssignmentsRequest,ListIAMPolicyAssignmentsResult> asyncHandler)
AmazonQuickSightAsyncLists IAM policy assignments in the current Amazon QuickSight account.
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 IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIAMPolicyAssignmentsForUserAsync in interface AmazonQuickSightAsyncpublic Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest request, AsyncHandler<ListIAMPolicyAssignmentsForUserRequest,ListIAMPolicyAssignmentsForUserResult> asyncHandler)
AmazonQuickSightAsyncLists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
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<ListNamespacesResult> listNamespacesAsync(ListNamespacesRequest request)
AmazonQuickSightAsyncLists the namespaces for the specified Amazon Web Services account.
listNamespacesAsync in interface AmazonQuickSightAsyncpublic Future<ListNamespacesResult> listNamespacesAsync(ListNamespacesRequest request, AsyncHandler<ListNamespacesRequest,ListNamespacesResult> asyncHandler)
AmazonQuickSightAsyncLists the namespaces for the specified Amazon Web Services account.
listNamespacesAsync 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.
listTagsForResourceAsync in interface AmazonQuickSightAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonQuickSightAsyncLists the tags assigned to a resource.
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.
listTemplateAliasesAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplateAliasesResult> listTemplateAliasesAsync(ListTemplateAliasesRequest request, AsyncHandler<ListTemplateAliasesRequest,ListTemplateAliasesResult> asyncHandler)
AmazonQuickSightAsyncLists all the aliases of a 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 current Amazon QuickSight account.
listTemplateVersionsAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplateVersionsResult> listTemplateVersionsAsync(ListTemplateVersionsRequest request, AsyncHandler<ListTemplateVersionsRequest,ListTemplateVersionsResult> asyncHandler)
AmazonQuickSightAsyncLists all the versions of the templates in the current Amazon QuickSight account.
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 current Amazon QuickSight account.
listTemplatesAsync in interface AmazonQuickSightAsyncpublic Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest request, AsyncHandler<ListTemplatesRequest,ListTemplatesResult> asyncHandler)
AmazonQuickSightAsyncLists all the templates in the current Amazon QuickSight account.
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<ListThemeAliasesResult> listThemeAliasesAsync(ListThemeAliasesRequest request)
AmazonQuickSightAsyncLists all the aliases of a theme.
listThemeAliasesAsync in interface AmazonQuickSightAsyncpublic Future<ListThemeAliasesResult> listThemeAliasesAsync(ListThemeAliasesRequest request, AsyncHandler<ListThemeAliasesRequest,ListThemeAliasesResult> asyncHandler)
AmazonQuickSightAsyncLists all the aliases of a theme.
listThemeAliasesAsync 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<ListThemeVersionsResult> listThemeVersionsAsync(ListThemeVersionsRequest request)
AmazonQuickSightAsyncLists all the versions of the themes in the current Amazon Web Services account.
listThemeVersionsAsync in interface AmazonQuickSightAsyncpublic Future<ListThemeVersionsResult> listThemeVersionsAsync(ListThemeVersionsRequest request, AsyncHandler<ListThemeVersionsRequest,ListThemeVersionsResult> asyncHandler)
AmazonQuickSightAsyncLists all the versions of the themes in the current Amazon Web Services account.
listThemeVersionsAsync 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<ListThemesResult> listThemesAsync(ListThemesRequest request)
AmazonQuickSightAsyncLists all the themes in the current Amazon Web Services account.
listThemesAsync in interface AmazonQuickSightAsyncpublic Future<ListThemesResult> listThemesAsync(ListThemesRequest request, AsyncHandler<ListThemesRequest,ListThemesResult> asyncHandler)
AmazonQuickSightAsyncLists all the themes in the current Amazon Web Services account.
listThemesAsync 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.
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.
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.
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.
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 Identity and Access Management (IAM) identity or role specified in the request.
registerUserAsync in interface AmazonQuickSightAsyncpublic Future<RegisterUserResult> registerUserAsync(RegisterUserRequest request, AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
AmazonQuickSightAsyncCreates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
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<RestoreAnalysisResult> restoreAnalysisAsync(RestoreAnalysisRequest request)
AmazonQuickSightAsyncRestores an analysis.
restoreAnalysisAsync in interface AmazonQuickSightAsyncpublic Future<RestoreAnalysisResult> restoreAnalysisAsync(RestoreAnalysisRequest request, AsyncHandler<RestoreAnalysisRequest,RestoreAnalysisResult> asyncHandler)
AmazonQuickSightAsyncRestores an analysis.
restoreAnalysisAsync 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<SearchAnalysesResult> searchAnalysesAsync(SearchAnalysesRequest request)
AmazonQuickSightAsyncSearches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalysesAsync in interface AmazonQuickSightAsyncpublic Future<SearchAnalysesResult> searchAnalysesAsync(SearchAnalysesRequest request, AsyncHandler<SearchAnalysesRequest,SearchAnalysesResult> asyncHandler)
AmazonQuickSightAsyncSearches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalysesAsync 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<SearchDashboardsResult> searchDashboardsAsync(SearchDashboardsRequest request)
AmazonQuickSightAsyncSearches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchDashboardsAsync in interface AmazonQuickSightAsyncpublic Future<SearchDashboardsResult> searchDashboardsAsync(SearchDashboardsRequest request, AsyncHandler<SearchDashboardsRequest,SearchDashboardsResult> asyncHandler)
AmazonQuickSightAsyncSearches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchDashboardsAsync 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<SearchFoldersResult> searchFoldersAsync(SearchFoldersRequest request)
AmazonQuickSightAsyncSearches the subfolders in a folder.
searchFoldersAsync in interface AmazonQuickSightAsyncpublic Future<SearchFoldersResult> searchFoldersAsync(SearchFoldersRequest request, AsyncHandler<SearchFoldersRequest,SearchFoldersResult> asyncHandler)
AmazonQuickSightAsyncSearches the subfolders in a folder.
searchFoldersAsync 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<SearchGroupsResult> searchGroupsAsync(SearchGroupsRequest request)
AmazonQuickSightAsync
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsAsync in interface AmazonQuickSightAsyncpublic Future<SearchGroupsResult> searchGroupsAsync(SearchGroupsRequest request, AsyncHandler<SearchGroupsRequest,SearchGroupsResult> asyncHandler)
AmazonQuickSightAsync
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsAsync 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 one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
tagResourceAsync in interface AmazonQuickSightAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonQuickSightAsyncAssigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
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.
untagResourceAsync in interface AmazonQuickSightAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonQuickSightAsyncRemoves a tag or tags from a resource.
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<UpdateAccountCustomizationResult> updateAccountCustomizationAsync(UpdateAccountCustomizationRequest request)
AmazonQuickSightAsyncUpdates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
updateAccountCustomizationAsync in interface AmazonQuickSightAsyncpublic Future<UpdateAccountCustomizationResult> updateAccountCustomizationAsync(UpdateAccountCustomizationRequest request, AsyncHandler<UpdateAccountCustomizationRequest,UpdateAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsyncUpdates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
updateAccountCustomizationAsync 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<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request)
AmazonQuickSightAsyncUpdates the Amazon QuickSight settings in your Amazon Web Services account.
updateAccountSettingsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest request, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
AmazonQuickSightAsyncUpdates the Amazon QuickSight settings in your Amazon Web Services account.
updateAccountSettingsAsync 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<UpdateAnalysisResult> updateAnalysisAsync(UpdateAnalysisRequest request)
AmazonQuickSightAsyncUpdates an analysis in Amazon QuickSight
updateAnalysisAsync in interface AmazonQuickSightAsyncpublic Future<UpdateAnalysisResult> updateAnalysisAsync(UpdateAnalysisRequest request, AsyncHandler<UpdateAnalysisRequest,UpdateAnalysisResult> asyncHandler)
AmazonQuickSightAsyncUpdates an analysis in Amazon QuickSight
updateAnalysisAsync 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<UpdateAnalysisPermissionsResult> updateAnalysisPermissionsAsync(UpdateAnalysisPermissionsRequest request)
AmazonQuickSightAsyncUpdates the read and write permissions for an analysis.
updateAnalysisPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateAnalysisPermissionsResult> updateAnalysisPermissionsAsync(UpdateAnalysisPermissionsRequest request, AsyncHandler<UpdateAnalysisPermissionsRequest,UpdateAnalysisPermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates the read and write permissions for an analysis.
updateAnalysisPermissionsAsync 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 an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
updateDashboardAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest request, AsyncHandler<UpdateDashboardRequest,UpdateDashboardResult> asyncHandler)
AmazonQuickSightAsyncUpdates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
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.
updateDashboardPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardPermissionsResult> updateDashboardPermissionsAsync(UpdateDashboardPermissionsRequest request, AsyncHandler<UpdateDashboardPermissionsRequest,UpdateDashboardPermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates read and write permissions on a dashboard.
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.
updateDashboardPublishedVersionAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDashboardPublishedVersionResult> updateDashboardPublishedVersionAsync(UpdateDashboardPublishedVersionRequest request, AsyncHandler<UpdateDashboardPublishedVersionRequest,UpdateDashboardPublishedVersionResult> asyncHandler)
AmazonQuickSightAsyncUpdates the published version of a dashboard.
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. This operation doesn't support datasets that include uploaded files as a source.
updateDataSetAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest request, AsyncHandler<UpdateDataSetRequest,UpdateDataSetResult> asyncHandler)
AmazonQuickSightAsyncUpdates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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.
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.
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.
updateDataSourceAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
AmazonQuickSightAsyncUpdates a data source.
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.
updateDataSourcePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateDataSourcePermissionsResult> updateDataSourcePermissionsAsync(UpdateDataSourcePermissionsRequest request, AsyncHandler<UpdateDataSourcePermissionsRequest,UpdateDataSourcePermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates the permissions to a data source.
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<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest request)
AmazonQuickSightAsyncUpdates the name of a folder.
updateFolderAsync in interface AmazonQuickSightAsyncpublic Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest request, AsyncHandler<UpdateFolderRequest,UpdateFolderResult> asyncHandler)
AmazonQuickSightAsyncUpdates the name of a folder.
updateFolderAsync 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<UpdateFolderPermissionsResult> updateFolderPermissionsAsync(UpdateFolderPermissionsRequest request)
AmazonQuickSightAsyncUpdates permissions of a folder.
updateFolderPermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateFolderPermissionsResult> updateFolderPermissionsAsync(UpdateFolderPermissionsRequest request, AsyncHandler<UpdateFolderPermissionsRequest,UpdateFolderPermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates permissions of a folder.
updateFolderPermissionsAsync 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.
updateGroupAsync in interface AmazonQuickSightAsyncpublic Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AmazonQuickSightAsyncChanges a group description.
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)
AmazonQuickSightAsync
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities.
updateIAMPolicyAssignmentAsync in interface AmazonQuickSightAsyncpublic Future<UpdateIAMPolicyAssignmentResult> updateIAMPolicyAssignmentAsync(UpdateIAMPolicyAssignmentRequest request, AsyncHandler<UpdateIAMPolicyAssignmentRequest,UpdateIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsync
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities.
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<UpdateIpRestrictionResult> updateIpRestrictionAsync(UpdateIpRestrictionRequest request)
AmazonQuickSightAsync
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules.
You can use the DescribeIpRestriction operation to get the current rule map.
updateIpRestrictionAsync in interface AmazonQuickSightAsyncpublic Future<UpdateIpRestrictionResult> updateIpRestrictionAsync(UpdateIpRestrictionRequest request, AsyncHandler<UpdateIpRestrictionRequest,UpdateIpRestrictionResult> asyncHandler)
AmazonQuickSightAsync
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules.
You can use the DescribeIpRestriction operation to get the current rule map.
updateIpRestrictionAsync 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 Amazon QuickSight analysis or another template.
updateTemplateAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest request, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResult> asyncHandler)
AmazonQuickSightAsyncUpdates a template from an existing Amazon QuickSight analysis or another template.
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.
updateTemplateAliasAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplateAliasResult> updateTemplateAliasAsync(UpdateTemplateAliasRequest request, AsyncHandler<UpdateTemplateAliasRequest,UpdateTemplateAliasResult> asyncHandler)
AmazonQuickSightAsyncUpdates the template alias of a template.
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 resource permissions for a template.
updateTemplatePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateTemplatePermissionsResult> updateTemplatePermissionsAsync(UpdateTemplatePermissionsRequest request, AsyncHandler<UpdateTemplatePermissionsRequest,UpdateTemplatePermissionsResult> asyncHandler)
AmazonQuickSightAsyncUpdates the resource permissions for a template.
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<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest request)
AmazonQuickSightAsyncUpdates a theme.
updateThemeAsync in interface AmazonQuickSightAsyncpublic Future<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest request, AsyncHandler<UpdateThemeRequest,UpdateThemeResult> asyncHandler)
AmazonQuickSightAsyncUpdates a theme.
updateThemeAsync 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<UpdateThemeAliasResult> updateThemeAliasAsync(UpdateThemeAliasRequest request)
AmazonQuickSightAsyncUpdates an alias of a theme.
updateThemeAliasAsync in interface AmazonQuickSightAsyncpublic Future<UpdateThemeAliasResult> updateThemeAliasAsync(UpdateThemeAliasRequest request, AsyncHandler<UpdateThemeAliasRequest,UpdateThemeAliasResult> asyncHandler)
AmazonQuickSightAsyncUpdates an alias of a theme.
updateThemeAliasAsync 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<UpdateThemePermissionsResult> updateThemePermissionsAsync(UpdateThemePermissionsRequest request)
AmazonQuickSightAsync
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on,
for example "quicksight:DescribeTheme".
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
updateThemePermissionsAsync in interface AmazonQuickSightAsyncpublic Future<UpdateThemePermissionsResult> updateThemePermissionsAsync(UpdateThemePermissionsRequest request, AsyncHandler<UpdateThemePermissionsRequest,UpdateThemePermissionsResult> asyncHandler)
AmazonQuickSightAsync
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on,
for example "quicksight:DescribeTheme".
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
updateThemePermissionsAsync 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.
updateUserAsync in interface AmazonQuickSightAsyncpublic Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonQuickSightAsyncUpdates an Amazon QuickSight user.
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 AmazonQuickSightClient