@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQuickSightAsync extends AmazonQuickSight
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonQuickSightAsync instead.
Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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.
ENDPOINT_PREFIXcancelIngestion, createAccountCustomization, createAnalysis, createDashboard, createDataSet, createDataSource, createGroup, createGroupMembership, createIAMPolicyAssignment, createIngestion, createNamespace, createTemplate, createTemplateAlias, createTheme, createThemeAlias, deleteAccountCustomization, deleteAnalysis, deleteDashboard, deleteDataSet, deleteDataSource, deleteGroup, deleteGroupMembership, deleteIAMPolicyAssignment, deleteNamespace, deleteTemplate, deleteTemplateAlias, deleteTheme, deleteThemeAlias, deleteUser, deleteUserByPrincipalId, describeAccountCustomization, describeAccountSettings, describeAnalysis, describeAnalysisPermissions, describeDashboard, describeDashboardPermissions, describeDataSet, describeDataSetPermissions, describeDataSource, describeDataSourcePermissions, describeGroup, describeIAMPolicyAssignment, describeIngestion, describeNamespace, describeTemplate, describeTemplateAlias, describeTemplatePermissions, describeTheme, describeThemeAlias, describeThemePermissions, describeUser, getCachedResponseMetadata, getDashboardEmbedUrl, getSessionEmbedUrl, listAnalyses, listDashboards, listDashboardVersions, listDataSets, listDataSources, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listNamespaces, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listThemeAliases, listThemes, listThemeVersions, listUserGroups, listUsers, registerUser, restoreAnalysis, searchAnalyses, searchDashboards, shutdown, tagResource, untagResource, updateAccountCustomization, updateAccountSettings, updateAnalysis, updateAnalysisPermissions, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateGroup, updateIAMPolicyAssignment, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateTheme, updateThemeAlias, updateThemePermissions, updateUserFuture<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionRequest - Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest cancelIngestionRequest, AsyncHandler<CancelIngestionRequest,CancelIngestionResult> asyncHandler)
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionRequest - 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.Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization or UpdateAccountCustomization API operation. To
further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight
in the Amazon QuickSight User Guide.
You can create customizations for your AWS 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 AWS account. To
find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you 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 won't be visible to your users even if you use this API operation to make it the default theme.
createAccountCustomizationRequest - Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest createAccountCustomizationRequest, AsyncHandler<CreateAccountCustomizationRequest,CreateAccountCustomizationResult> asyncHandler)
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization or UpdateAccountCustomization API operation. To
further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight
in the Amazon QuickSight User Guide.
You can create customizations for your AWS 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 AWS account. To
find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you 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 won't be visible to your users even if you use this API operation to make it the default theme.
createAccountCustomizationRequest - 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.Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
createAnalysisRequest - Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest createAnalysisRequest, AsyncHandler<CreateAnalysisRequest,CreateAnalysisResult> asyncHandler)
Creates an analysis in Amazon QuickSight.
createAnalysisRequest - 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.Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API
operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
createDashboardRequest - Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest createDashboardRequest, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API
operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
createDashboardRequest - 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.Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
createDataSetRequest - Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest createDataSetRequest, AsyncHandler<CreateDataSetRequest,CreateDataSetResult> asyncHandler)
Creates a dataset.
createDataSetRequest - 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.Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
createDataSourceRequest - Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
Creates a data source.
createDataSourceRequest - 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.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroupRequest - The request object for this operation.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroupRequest - 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.Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembershipRequest - Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest createGroupMembershipRequest, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembershipRequest - 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.Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest createIAMPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIAMPolicyAssignmentRequest - Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest createIAMPolicyAssignmentRequest, AsyncHandler<CreateIAMPolicyAssignmentRequest,CreateIAMPolicyAssignmentResult> asyncHandler)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIAMPolicyAssignmentRequest - 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.Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionRequest - Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest createIngestionRequest, AsyncHandler<CreateIngestionRequest,CreateIngestionResult> asyncHandler)
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionRequest - 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.Future<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the 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 AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
createNamespaceRequest - Future<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest createNamespaceRequest, AsyncHandler<CreateNamespaceRequest,CreateNamespaceResult> asyncHandler)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the 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 AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
createNamespaceRequest - 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.Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateRequest - Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest createTemplateRequest, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateRequest - 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.Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
createTemplateAliasRequest - Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest createTemplateAliasRequest, AsyncHandler<CreateTemplateAliasRequest,CreateTemplateAliasResult> asyncHandler)
Creates a template alias for a template.
createTemplateAliasRequest - 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.Future<CreateThemeResult> createThemeAsync(CreateThemeRequest createThemeRequest)
Creates 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.
createThemeRequest - Future<CreateThemeResult> createThemeAsync(CreateThemeRequest createThemeRequest, AsyncHandler<CreateThemeRequest,CreateThemeResult> asyncHandler)
Creates 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.
createThemeRequest - 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.Future<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest createThemeAliasRequest)
Creates a theme alias for a theme.
createThemeAliasRequest - Future<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest createThemeAliasRequest, AsyncHandler<CreateThemeAliasRequest,CreateThemeAliasResult> asyncHandler)
Creates a theme alias for a theme.
createThemeAliasRequest - 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.Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS Account and QuickSight namespace.
deleteAccountCustomizationRequest - Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest, AsyncHandler<DeleteAccountCustomizationRequest,DeleteAccountCustomizationResult> asyncHandler)
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS Account and QuickSight namespace.
deleteAccountCustomizationRequest - 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.Future<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest deleteAnalysisRequest)
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. QuickSight
attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, 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 QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisRequest - Future<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest deleteAnalysisRequest, AsyncHandler<DeleteAnalysisRequest,DeleteAnalysisResult> asyncHandler)
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. QuickSight
attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, 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 QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisRequest - 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.Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
deleteDashboardRequest - Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest deleteDashboardRequest, AsyncHandler<DeleteDashboardRequest,DeleteDashboardResult> asyncHandler)
Deletes a dashboard.
deleteDashboardRequest - 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.Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
deleteDataSetRequest - Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest deleteDataSetRequest, AsyncHandler<DeleteDataSetRequest,DeleteDataSetResult> asyncHandler)
Deletes a dataset.
deleteDataSetRequest - 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.Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSourceRequest - Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSourceRequest - 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.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
deleteGroupRequest - Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Removes a user group from Amazon QuickSight.
deleteGroupRequest - 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.Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembershipRequest - Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest deleteGroupMembershipRequest, AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembershipRequest - 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.Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest deleteIAMPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignmentRequest - Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest deleteIAMPolicyAssignmentRequest, AsyncHandler<DeleteIAMPolicyAssignmentRequest,DeleteIAMPolicyAssignmentResult> asyncHandler)
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignmentRequest - 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.Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes 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.
deleteNamespaceRequest - Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest deleteNamespaceRequest, AsyncHandler<DeleteNamespaceRequest,DeleteNamespaceResult> asyncHandler)
Deletes 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.
deleteNamespaceRequest - 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.Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
deleteTemplateRequest - Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest deleteTemplateRequest, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
Deletes a template.
deleteTemplateRequest - 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.Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTemplateAliasRequest - Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest deleteTemplateAliasRequest, AsyncHandler<DeleteTemplateAliasRequest,DeleteTemplateAliasResult> asyncHandler)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTemplateAliasRequest - 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.Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest deleteThemeRequest)
Deletes a theme.
deleteThemeRequest - Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest deleteThemeRequest, AsyncHandler<DeleteThemeRequest,DeleteThemeResult> asyncHandler)
Deletes a theme.
deleteThemeRequest - 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.Future<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest deleteThemeAliasRequest)
Deletes 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.
deleteThemeAliasRequest - Future<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest deleteThemeAliasRequest, AsyncHandler<DeleteThemeAliasRequest,DeleteThemeAliasResult> asyncHandler)
Deletes 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.
deleteThemeAliasRequest - 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.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUserRequest - Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUserRequest - 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.Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdRequest - Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdRequest - 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.Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region. The 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.
AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of
the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home
region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, 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 QuickSight in any AWS Region, unless they are
constrained to a namespace.
To run the command in a different AWS Region, you change your region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default AWS Region. Use Enter to key the same settings for your
keys. For more information, see Configuring the AWS 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 AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an
AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS
Account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the
CreateAccountCustomization command in each AWS Region where you want to apply the same
customizations.
describeAccountCustomizationRequest - Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest describeAccountCustomizationRequest, AsyncHandler<DescribeAccountCustomizationRequest,DescribeAccountCustomizationResult> asyncHandler)
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region. The 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.
AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of
the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home
region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, 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 QuickSight in any AWS Region, unless they are
constrained to a namespace.
To run the command in a different AWS Region, you change your region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default AWS Region. Use Enter to key the same settings for your
keys. For more information, see Configuring the AWS 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 AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an
AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS
Account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the
CreateAccountCustomization command in each AWS Region where you want to apply the same
customizations.
describeAccountCustomizationRequest - 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.Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
describeAccountSettingsRequest - Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest describeAccountSettingsRequest, AsyncHandler<DescribeAccountSettingsRequest,DescribeAccountSettingsResult> asyncHandler)
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
describeAccountSettingsRequest - 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.Future<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
describeAnalysisRequest - Future<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest describeAnalysisRequest, AsyncHandler<DescribeAnalysisRequest,DescribeAnalysisResult> asyncHandler)
Provides a summary of the metadata for an analysis.
describeAnalysisRequest - 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.Future<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsRequest - Future<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest, AsyncHandler<DescribeAnalysisPermissionsRequest,DescribeAnalysisPermissionsResult> asyncHandler)
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsRequest - 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.Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
describeDashboardRequest - Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest describeDashboardRequest, AsyncHandler<DescribeDashboardRequest,DescribeDashboardResult> asyncHandler)
Provides a summary for a dashboard.
describeDashboardRequest - 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.Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
describeDashboardPermissionsRequest - Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest, AsyncHandler<DescribeDashboardPermissionsRequest,DescribeDashboardPermissionsResult> asyncHandler)
Describes read and write permissions for a dashboard.
describeDashboardPermissionsRequest - 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.Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
describeDataSetRequest - Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest describeDataSetRequest, AsyncHandler<DescribeDataSetRequest,DescribeDataSetResult> asyncHandler)
Describes a dataset.
describeDataSetRequest - 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.Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
describeDataSetPermissionsRequest - Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest, AsyncHandler<DescribeDataSetPermissionsRequest,DescribeDataSetPermissionsResult> asyncHandler)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
describeDataSetPermissionsRequest - 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.Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
describeDataSourceRequest - Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest describeDataSourceRequest, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
Describes a data source.
describeDataSourceRequest - 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.Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
describeDataSourcePermissionsRequest - Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest, AsyncHandler<DescribeDataSourcePermissionsRequest,DescribeDataSourcePermissionsResult> asyncHandler)
Describes the resource permissions for a data source.
describeDataSourcePermissionsRequest - 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.Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroupRequest - Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest describeGroupRequest, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroupRequest - 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.Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignmentRequest - Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest, AsyncHandler<DescribeIAMPolicyAssignmentRequest,DescribeIAMPolicyAssignmentResult> asyncHandler)
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignmentRequest - 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.Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
describeIngestionRequest - Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest describeIngestionRequest, AsyncHandler<DescribeIngestionRequest,DescribeIngestionResult> asyncHandler)
Describes a SPICE ingestion.
describeIngestionRequest - 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.Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
describeNamespaceRequest - Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest describeNamespaceRequest, AsyncHandler<DescribeNamespaceRequest,DescribeNamespaceResult> asyncHandler)
Describes the current namespace.
describeNamespaceRequest - 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.Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
describeTemplateRequest - Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest describeTemplateRequest, AsyncHandler<DescribeTemplateRequest,DescribeTemplateResult> asyncHandler)
Describes a template's metadata.
describeTemplateRequest - 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.Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
describeTemplateAliasRequest - Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest describeTemplateAliasRequest, AsyncHandler<DescribeTemplateAliasRequest,DescribeTemplateAliasResult> asyncHandler)
Describes the template alias for a template.
describeTemplateAliasRequest - 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.Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
describeTemplatePermissionsRequest - Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest, AsyncHandler<DescribeTemplatePermissionsRequest,DescribeTemplatePermissionsResult> asyncHandler)
Describes read and write permissions on a template.
describeTemplatePermissionsRequest - 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.Future<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest describeThemeRequest)
Describes a theme.
describeThemeRequest - Future<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest describeThemeRequest, AsyncHandler<DescribeThemeRequest,DescribeThemeResult> asyncHandler)
Describes a theme.
describeThemeRequest - 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.Future<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest describeThemeAliasRequest)
Describes the alias for a theme.
describeThemeAliasRequest - Future<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest describeThemeAliasRequest, AsyncHandler<DescribeThemeAliasRequest,DescribeThemeAliasResult> asyncHandler)
Describes the alias for a theme.
describeThemeAliasRequest - 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.Future<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
describeThemePermissionsRequest - Future<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest describeThemePermissionsRequest, AsyncHandler<DescribeThemePermissionsRequest,DescribeThemePermissionsResult> asyncHandler)
Describes the read and write permissions for a theme.
describeThemePermissionsRequest - 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.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
describeUserRequest - Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Returns information about a user, given the user name.
describeUserRequest - 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.Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed an 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 Amazon QuickSight in the Amazon QuickSight User Guide .
getDashboardEmbedUrlRequest - Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
Generates a session URL and authorization code that you can use to embed an 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 Amazon QuickSight in the Amazon QuickSight User Guide .
getDashboardEmbedUrlRequest - 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.Future<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the 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 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:
getSessionEmbedUrlRequest - Future<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest, AsyncHandler<GetSessionEmbedUrlRequest,GetSessionEmbedUrlResult> asyncHandler)
Generates a session URL and authorization code that you can use to embed the 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 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:
getSessionEmbedUrlRequest - 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.Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
listAnalysesRequest - Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest listAnalysesRequest, AsyncHandler<ListAnalysesRequest,ListAnalysesResult> asyncHandler)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
listAnalysesRequest - 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.Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersionsRequest - Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest listDashboardVersionsRequest, AsyncHandler<ListDashboardVersionsRequest,ListDashboardVersionsResult> asyncHandler)
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersionsRequest - 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.Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an AWS account.
listDashboardsRequest - Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
Lists dashboards in an AWS account.
listDashboardsRequest - 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.Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSetsRequest - Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest listDataSetsRequest, AsyncHandler<ListDataSetsRequest,ListDataSetsResult> asyncHandler)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSetsRequest - 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.Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current AWS Region that belong to this AWS account.
listDataSourcesRequest - Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists data sources in current AWS Region that belong to this AWS account.
listDataSourcesRequest - 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.Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
listGroupMembershipsRequest - Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest listGroupMembershipsRequest, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
Lists member users in a group.
listGroupMembershipsRequest - 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.Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
listGroupsRequest - Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest listGroupsRequest, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
Lists all user groups in Amazon QuickSight.
listGroupsRequest - 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.Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsRequest - Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest, AsyncHandler<ListIAMPolicyAssignmentsRequest,ListIAMPolicyAssignmentsResult> asyncHandler)
Lists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsRequest - 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.Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIAMPolicyAssignmentsForUserRequest - Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest, AsyncHandler<ListIAMPolicyAssignmentsForUserRequest,ListIAMPolicyAssignmentsForUserResult> asyncHandler)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIAMPolicyAssignmentsForUserRequest - 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.Future<ListIngestionsResult> listIngestionsAsync(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
listIngestionsRequest - Future<ListIngestionsResult> listIngestionsAsync(ListIngestionsRequest listIngestionsRequest, AsyncHandler<ListIngestionsRequest,ListIngestionsResult> asyncHandler)
Lists the history of SPICE ingestions for a dataset.
listIngestionsRequest - 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.Future<ListNamespacesResult> listNamespacesAsync(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified AWS account.
listNamespacesRequest - Future<ListNamespacesResult> listNamespacesAsync(ListNamespacesRequest listNamespacesRequest, AsyncHandler<ListNamespacesRequest,ListNamespacesResult> asyncHandler)
Lists the namespaces for the specified AWS account.
listNamespacesRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags assigned to a resource.
listTagsForResourceRequest - 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.Future<ListTemplateAliasesResult> listTemplateAliasesAsync(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
listTemplateAliasesRequest - Future<ListTemplateAliasesResult> listTemplateAliasesAsync(ListTemplateAliasesRequest listTemplateAliasesRequest, AsyncHandler<ListTemplateAliasesRequest,ListTemplateAliasesResult> asyncHandler)
Lists all the aliases of a template.
listTemplateAliasesRequest - 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.Future<ListTemplateVersionsResult> listTemplateVersionsAsync(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersionsRequest - Future<ListTemplateVersionsResult> listTemplateVersionsAsync(ListTemplateVersionsRequest listTemplateVersionsRequest, AsyncHandler<ListTemplateVersionsRequest,ListTemplateVersionsResult> asyncHandler)
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersionsRequest - 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.Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
listTemplatesRequest - Future<ListTemplatesResult> listTemplatesAsync(ListTemplatesRequest listTemplatesRequest, AsyncHandler<ListTemplatesRequest,ListTemplatesResult> asyncHandler)
Lists all the templates in the current Amazon QuickSight account.
listTemplatesRequest - 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.Future<ListThemeAliasesResult> listThemeAliasesAsync(ListThemeAliasesRequest listThemeAliasesRequest)
Lists all the aliases of a theme.
listThemeAliasesRequest - Future<ListThemeAliasesResult> listThemeAliasesAsync(ListThemeAliasesRequest listThemeAliasesRequest, AsyncHandler<ListThemeAliasesRequest,ListThemeAliasesResult> asyncHandler)
Lists all the aliases of a theme.
listThemeAliasesRequest - 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.Future<ListThemeVersionsResult> listThemeVersionsAsync(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current AWS account.
listThemeVersionsRequest - Future<ListThemeVersionsResult> listThemeVersionsAsync(ListThemeVersionsRequest listThemeVersionsRequest, AsyncHandler<ListThemeVersionsRequest,ListThemeVersionsResult> asyncHandler)
Lists all the versions of the themes in the current AWS account.
listThemeVersionsRequest - 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.Future<ListThemesResult> listThemesAsync(ListThemesRequest listThemesRequest)
Lists all the themes in the current AWS account.
listThemesRequest - Future<ListThemesResult> listThemesAsync(ListThemesRequest listThemesRequest, AsyncHandler<ListThemesRequest,ListThemesResult> asyncHandler)
Lists all the themes in the current AWS account.
listThemesRequest - 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.Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroupsRequest - Future<ListUserGroupsResult> listUserGroupsAsync(ListUserGroupsRequest listUserGroupsRequest, AsyncHandler<ListUserGroupsRequest,ListUserGroupsResult> asyncHandler)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroupsRequest - 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.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsersRequest - Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsersRequest - 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.Future<RegisterUserResult> registerUserAsync(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUserRequest - Future<RegisterUserResult> registerUserAsync(RegisterUserRequest registerUserRequest, AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUserRequest - 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.Future<RestoreAnalysisResult> restoreAnalysisAsync(RestoreAnalysisRequest restoreAnalysisRequest)
Restores an analysis.
restoreAnalysisRequest - Future<RestoreAnalysisResult> restoreAnalysisAsync(RestoreAnalysisRequest restoreAnalysisRequest, AsyncHandler<RestoreAnalysisRequest,RestoreAnalysisResult> asyncHandler)
Restores an analysis.
restoreAnalysisRequest - 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.Future<SearchAnalysesResult> searchAnalysesAsync(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
searchAnalysesRequest - Future<SearchAnalysesResult> searchAnalysesAsync(SearchAnalysesRequest searchAnalysesRequest, AsyncHandler<SearchAnalysesRequest,SearchAnalysesResult> asyncHandler)
Searches for analyses that belong to the user specified in the filter.
searchAnalysesRequest - 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.Future<SearchDashboardsResult> searchDashboardsAsync(SearchDashboardsRequest searchDashboardsRequest)
Searches for dashboards that belong to a user.
searchDashboardsRequest - Future<SearchDashboardsResult> searchDashboardsAsync(SearchDashboardsRequest searchDashboardsRequest, AsyncHandler<SearchDashboardsRequest,SearchDashboardsResult> asyncHandler)
Searches for dashboards that belong to a user.
searchDashboardsRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag or tags from a resource.
untagResourceRequest - 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.Future<UpdateAccountCustomizationResult> updateAccountCustomizationAsync(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find
out which customizations apply, use the DescribeAccountCustomization API operation.
updateAccountCustomizationRequest - Future<UpdateAccountCustomizationResult> updateAccountCustomizationAsync(UpdateAccountCustomizationRequest updateAccountCustomizationRequest, AsyncHandler<UpdateAccountCustomizationRequest,UpdateAccountCustomizationResult> asyncHandler)
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find
out which customizations apply, use the DescribeAccountCustomization API operation.
updateAccountCustomizationRequest - 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.Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your AWS Account.
updateAccountSettingsRequest - Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
Updates the Amazon QuickSight settings in your AWS Account.
updateAccountSettingsRequest - 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.Future<UpdateAnalysisResult> updateAnalysisAsync(UpdateAnalysisRequest updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
updateAnalysisRequest - Future<UpdateAnalysisResult> updateAnalysisAsync(UpdateAnalysisRequest updateAnalysisRequest, AsyncHandler<UpdateAnalysisRequest,UpdateAnalysisResult> asyncHandler)
Updates an analysis in Amazon QuickSight
updateAnalysisRequest - 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.Future<UpdateAnalysisPermissionsResult> updateAnalysisPermissionsAsync(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
updateAnalysisPermissionsRequest - Future<UpdateAnalysisPermissionsResult> updateAnalysisPermissionsAsync(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest, AsyncHandler<UpdateAnalysisPermissionsRequest,UpdateAnalysisPermissionsResult> asyncHandler)
Updates the read and write permissions for an analysis.
updateAnalysisPermissionsRequest - 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.Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an AWS account.
updateDashboardRequest - Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest updateDashboardRequest, AsyncHandler<UpdateDashboardRequest,UpdateDashboardResult> asyncHandler)
Updates a dashboard in an AWS account.
updateDashboardRequest - 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.Future<UpdateDashboardPermissionsResult> updateDashboardPermissionsAsync(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
updateDashboardPermissionsRequest - Future<UpdateDashboardPermissionsResult> updateDashboardPermissionsAsync(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest, AsyncHandler<UpdateDashboardPermissionsRequest,UpdateDashboardPermissionsResult> asyncHandler)
Updates read and write permissions on a dashboard.
updateDashboardPermissionsRequest - 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.Future<UpdateDashboardPublishedVersionResult> updateDashboardPublishedVersionAsync(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
updateDashboardPublishedVersionRequest - Future<UpdateDashboardPublishedVersionResult> updateDashboardPublishedVersionAsync(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest, AsyncHandler<UpdateDashboardPublishedVersionRequest,UpdateDashboardPublishedVersionResult> asyncHandler)
Updates the published version of a dashboard.
updateDashboardPublishedVersionRequest - 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.Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
updateDataSetRequest - Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest updateDataSetRequest, AsyncHandler<UpdateDataSetRequest,UpdateDataSetResult> asyncHandler)
Updates a dataset.
updateDataSetRequest - 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.Future<UpdateDataSetPermissionsResult> updateDataSetPermissionsAsync(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
updateDataSetPermissionsRequest - Future<UpdateDataSetPermissionsResult> updateDataSetPermissionsAsync(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest, AsyncHandler<UpdateDataSetPermissionsRequest,UpdateDataSetPermissionsResult> asyncHandler)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
updateDataSetPermissionsRequest - 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.Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
updateDataSourceRequest - Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates a data source.
updateDataSourceRequest - 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.Future<UpdateDataSourcePermissionsResult> updateDataSourcePermissionsAsync(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
updateDataSourcePermissionsRequest - Future<UpdateDataSourcePermissionsResult> updateDataSourcePermissionsAsync(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest, AsyncHandler<UpdateDataSourcePermissionsRequest,UpdateDataSourcePermissionsResult> asyncHandler)
Updates the permissions to a data source.
updateDataSourcePermissionsRequest - 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.Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Changes a group description.
updateGroupRequest - Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Changes a group description.
updateGroupRequest - 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.Future<UpdateIAMPolicyAssignmentResult> updateIAMPolicyAssignmentAsync(UpdateIAMPolicyAssignmentRequest updateIAMPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIAMPolicyAssignmentRequest - Future<UpdateIAMPolicyAssignmentResult> updateIAMPolicyAssignmentAsync(UpdateIAMPolicyAssignmentRequest updateIAMPolicyAssignmentRequest, AsyncHandler<UpdateIAMPolicyAssignmentRequest,UpdateIAMPolicyAssignmentResult> asyncHandler)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIAMPolicyAssignmentRequest - 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.Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplateRequest - Future<UpdateTemplateResult> updateTemplateAsync(UpdateTemplateRequest updateTemplateRequest, AsyncHandler<UpdateTemplateRequest,UpdateTemplateResult> asyncHandler)
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplateRequest - 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.Future<UpdateTemplateAliasResult> updateTemplateAliasAsync(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
updateTemplateAliasRequest - Future<UpdateTemplateAliasResult> updateTemplateAliasAsync(UpdateTemplateAliasRequest updateTemplateAliasRequest, AsyncHandler<UpdateTemplateAliasRequest,UpdateTemplateAliasResult> asyncHandler)
Updates the template alias of a template.
updateTemplateAliasRequest - 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.Future<UpdateTemplatePermissionsResult> updateTemplatePermissionsAsync(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
updateTemplatePermissionsRequest - Future<UpdateTemplatePermissionsResult> updateTemplatePermissionsAsync(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest, AsyncHandler<UpdateTemplatePermissionsRequest,UpdateTemplatePermissionsResult> asyncHandler)
Updates the resource permissions for a template.
updateTemplatePermissionsRequest - 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.Future<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest updateThemeRequest)
Updates a theme.
updateThemeRequest - Future<UpdateThemeResult> updateThemeAsync(UpdateThemeRequest updateThemeRequest, AsyncHandler<UpdateThemeRequest,UpdateThemeResult> asyncHandler)
Updates a theme.
updateThemeRequest - 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.Future<UpdateThemeAliasResult> updateThemeAliasAsync(UpdateThemeAliasRequest updateThemeAliasRequest)
Updates an alias of a theme.
updateThemeAliasRequest - Future<UpdateThemeAliasResult> updateThemeAliasAsync(UpdateThemeAliasRequest updateThemeAliasRequest, AsyncHandler<UpdateThemeAliasRequest,UpdateThemeAliasResult> asyncHandler)
Updates an alias of a theme.
updateThemeAliasRequest - 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.Future<UpdateThemePermissionsResult> updateThemePermissionsAsync(UpdateThemePermissionsRequest updateThemePermissionsRequest)
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.
updateThemePermissionsRequest - Future<UpdateThemePermissionsResult> updateThemePermissionsAsync(UpdateThemePermissionsRequest updateThemePermissionsRequest, AsyncHandler<UpdateThemePermissionsRequest,UpdateThemePermissionsResult> asyncHandler)
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.
updateThemePermissionsRequest - 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.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
updateUserRequest - Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates an Amazon QuickSight user.
updateUserRequest - 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.