@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 Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
ENDPOINT_PREFIXcancelIngestion, createAccountCustomization, createAccountSubscription, createAnalysis, createDashboard, createDataSet, createDataSource, createFolder, createFolderMembership, createGroup, createGroupMembership, createIAMPolicyAssignment, createIngestion, createNamespace, createRefreshSchedule, createTemplate, createTemplateAlias, createTheme, createThemeAlias, createTopic, createTopicRefreshSchedule, createVPCConnection, deleteAccountCustomization, deleteAccountSubscription, deleteAnalysis, deleteDashboard, deleteDataSet, deleteDataSetRefreshProperties, deleteDataSource, deleteFolder, deleteFolderMembership, deleteGroup, deleteGroupMembership, deleteIAMPolicyAssignment, deleteNamespace, deleteRefreshSchedule, deleteTemplate, deleteTemplateAlias, deleteTheme, deleteThemeAlias, deleteTopic, deleteTopicRefreshSchedule, deleteUser, deleteUserByPrincipalId, deleteVPCConnection, describeAccountCustomization, describeAccountSettings, describeAccountSubscription, describeAnalysis, describeAnalysisDefinition, describeAnalysisPermissions, describeAssetBundleExportJob, describeAssetBundleImportJob, describeDashboard, describeDashboardDefinition, describeDashboardPermissions, describeDataSet, describeDataSetPermissions, describeDataSetRefreshProperties, describeDataSource, describeDataSourcePermissions, describeFolder, describeFolderPermissions, describeFolderResolvedPermissions, describeGroup, describeGroupMembership, describeIAMPolicyAssignment, describeIngestion, describeIpRestriction, describeNamespace, describeRefreshSchedule, describeTemplate, describeTemplateAlias, describeTemplateDefinition, describeTemplatePermissions, describeTheme, describeThemeAlias, describeThemePermissions, describeTopic, describeTopicPermissions, describeTopicRefresh, describeTopicRefreshSchedule, describeUser, describeVPCConnection, generateEmbedUrlForAnonymousUser, generateEmbedUrlForRegisteredUser, getCachedResponseMetadata, getDashboardEmbedUrl, getSessionEmbedUrl, listAnalyses, listAssetBundleExportJobs, listAssetBundleImportJobs, listDashboards, listDashboardVersions, listDataSets, listDataSources, listFolderMembers, listFolders, listGroupMemberships, listGroups, listIAMPolicyAssignments, listIAMPolicyAssignmentsForUser, listIngestions, listNamespaces, listRefreshSchedules, listTagsForResource, listTemplateAliases, listTemplates, listTemplateVersions, listThemeAliases, listThemes, listThemeVersions, listTopicRefreshSchedules, listTopics, listUserGroups, listUsers, listVPCConnections, putDataSetRefreshProperties, registerUser, restoreAnalysis, searchAnalyses, searchDashboards, searchDataSets, searchDataSources, searchFolders, searchGroups, shutdown, startAssetBundleExportJob, startAssetBundleImportJob, tagResource, untagResource, updateAccountCustomization, updateAccountSettings, updateAnalysis, updateAnalysisPermissions, updateDashboard, updateDashboardPermissions, updateDashboardPublishedVersion, updateDataSet, updateDataSetPermissions, updateDataSource, updateDataSourcePermissions, updateFolder, updateFolderPermissions, updateGroup, updateIAMPolicyAssignment, updateIpRestriction, updatePublicSharingSettings, updateRefreshSchedule, updateTemplate, updateTemplateAlias, updateTemplatePermissions, updateTheme, updateThemeAlias, updateThemePermissions, updateTopic, updateTopicPermissions, updateTopicRefreshSchedule, updateUser, updateVPCConnectionFuture<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 for the current Amazon Web Services Region. Currently, you can add a
custom default theme by using the CreateAccountCustomization or
UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the
DescribeThemePermissions
API operation. To share the theme, grant permissions by using the
UpdateThemePermissions
API operation.
createAccountCustomizationRequest - Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest createAccountCustomizationRequest, AsyncHandler<CreateAccountCustomizationRequest,CreateAccountCustomizationResult> asyncHandler)
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a
custom default theme by using the CreateAccountCustomization or
UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the
DescribeThemePermissions
API operation. To share the theme, grant permissions by using the
UpdateThemePermissions
API operation.
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<CreateAccountSubscriptionResult> createAccountSubscriptionAsync(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe and CreateAccountSubscription actions,
make sure that both actions are set to Allow. If either action is set to Deny, the
Deny action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
createAccountSubscriptionRequest - Future<CreateAccountSubscriptionResult> createAccountSubscriptionAsync(CreateAccountSubscriptionRequest createAccountSubscriptionRequest, AsyncHandler<CreateAccountSubscriptionRequest,CreateAccountSubscriptionResult> asyncHandler)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe and CreateAccountSubscription actions,
make sure that both actions are set to Allow. If either action is set to Deny, the
Deny action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
createAccountSubscriptionRequest - 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. Analyses can be created either from a template or from an
AnalysisDefinition.
createAnalysisRequest - Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest createAnalysisRequest, AsyncHandler<CreateAnalysisRequest,CreateAnalysisResult> asyncHandler)
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition.
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 either a template or directly with a DashboardDefinition. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
createDashboardRequest - Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest createDashboardRequest, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
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. This operation doesn't support datasets that include uploaded files as a source.
createDataSetRequest - Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest createDataSetRequest, AsyncHandler<CreateDataSetRequest,CreateDataSetResult> asyncHandler)
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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<CreateFolderResult> createFolderAsync(CreateFolderRequest createFolderRequest)
Creates an empty shared folder.
createFolderRequest - Future<CreateFolderResult> createFolderAsync(CreateFolderRequest createFolderRequest, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
Creates an empty shared folder.
createFolderRequest - 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<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipRequest - Future<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest createFolderMembershipRequest, AsyncHandler<CreateFolderMembershipRequest,CreateFolderMembershipResult> asyncHandler)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipRequest - 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)
Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<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)
Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestionRequest - Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest createIngestionRequest, AsyncHandler<CreateIngestionRequest,CreateIngestionResult> asyncHandler)
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
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 Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
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 Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
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<CreateRefreshScheduleResult> createRefreshScheduleAsync(CreateRefreshScheduleRequest createRefreshScheduleRequest)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshScheduleRequest - Future<CreateRefreshScheduleResult> createRefreshScheduleAsync(CreateRefreshScheduleRequest createRefreshScheduleRequest, AsyncHandler<CreateRefreshScheduleRequest,CreateRefreshScheduleResult> asyncHandler)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshScheduleRequest - 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 either from a TemplateDefinition or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplateRequest - Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest createTemplateRequest, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest)
Creates a new Q topic.
createTopicRequest - Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a new Q topic.
createTopicRequest - 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<CreateTopicRefreshScheduleResult> createTopicRefreshScheduleAsync(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)
Creates a topic refresh schedule.
createTopicRefreshScheduleRequest - Future<CreateTopicRefreshScheduleResult> createTopicRefreshScheduleAsync(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest, AsyncHandler<CreateTopicRefreshScheduleRequest,CreateTopicRefreshScheduleResult> asyncHandler)
Creates a topic refresh schedule.
createTopicRefreshScheduleRequest - 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<CreateVPCConnectionResult> createVPCConnectionAsync(CreateVPCConnectionRequest createVPCConnectionRequest)
Creates a new VPC connection.
createVPCConnectionRequest - Future<CreateVPCConnectionResult> createVPCConnectionAsync(CreateVPCConnectionRequest createVPCConnectionRequest, AsyncHandler<CreateVPCConnectionRequest,CreateVPCConnectionResult> asyncHandler)
Creates a new VPC connection.
createVPCConnectionRequest - 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 Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomizationRequest - Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest, AsyncHandler<DeleteAccountCustomizationRequest,DeleteAccountCustomizationResult> asyncHandler)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon 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<DeleteAccountSubscriptionResult> deleteAccountSubscriptionAsync(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled parameter to False, then make
another call to the DeleteAccountSubscription API.
deleteAccountSubscriptionRequest - Future<DeleteAccountSubscriptionResult> deleteAccountSubscriptionAsync(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest, AsyncHandler<DeleteAccountSubscriptionRequest,DeleteAccountSubscriptionResult> asyncHandler)
Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled parameter to False, then make
another call to the DeleteAccountSubscription API.
deleteAccountSubscriptionRequest - 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. Amazon
QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the
DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
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. Amazon
QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the
DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
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<DeleteDataSetRefreshPropertiesResult> deleteDataSetRefreshPropertiesAsync(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshPropertiesRequest - Future<DeleteDataSetRefreshPropertiesResult> deleteDataSetRefreshPropertiesAsync(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest, AsyncHandler<DeleteDataSetRefreshPropertiesRequest,DeleteDataSetRefreshPropertiesResult> asyncHandler)
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshPropertiesRequest - 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<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest deleteFolderRequest)
Deletes an empty folder.
deleteFolderRequest - Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest deleteFolderRequest, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
Deletes an empty folder.
deleteFolderRequest - 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<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipRequest - Future<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest deleteFolderMembershipRequest, AsyncHandler<DeleteFolderMembershipRequest,DeleteFolderMembershipResult> asyncHandler)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipRequest - 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<DeleteRefreshScheduleResult> deleteRefreshScheduleAsync(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)
Deletes a refresh schedule from a dataset.
deleteRefreshScheduleRequest - Future<DeleteRefreshScheduleResult> deleteRefreshScheduleAsync(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest, AsyncHandler<DeleteRefreshScheduleRequest,DeleteRefreshScheduleResult> asyncHandler)
Deletes a refresh schedule from a dataset.
deleteRefreshScheduleRequest - 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<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
Deletes a topic.
deleteTopicRequest - Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Deletes a topic.
deleteTopicRequest - 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<DeleteTopicRefreshScheduleResult> deleteTopicRefreshScheduleAsync(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
deleteTopicRefreshScheduleRequest - Future<DeleteTopicRefreshScheduleResult> deleteTopicRefreshScheduleAsync(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest, AsyncHandler<DeleteTopicRefreshScheduleRequest,DeleteTopicRefreshScheduleResult> asyncHandler)
Deletes a topic refresh schedule.
deleteTopicRefreshScheduleRequest - 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 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 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<DeleteVPCConnectionResult> deleteVPCConnectionAsync(DeleteVPCConnectionRequest deleteVPCConnectionRequest)
Deletes a VPC connection.
deleteVPCConnectionRequest - Future<DeleteVPCConnectionResult> deleteVPCConnectionAsync(DeleteVPCConnectionRequest deleteVPCConnectionRequest, AsyncHandler<DeleteVPCConnectionRequest,DeleteVPCConnectionResult> asyncHandler)
Deletes a VPC connection.
deleteVPCConnectionRequest - 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 Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the
same customizations.
describeAccountCustomizationRequest - Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest describeAccountCustomizationRequest, AsyncHandler<DescribeAccountCustomizationRequest,DescribeAccountCustomizationResult> asyncHandler)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the
same customizations.
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 Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettingsRequest - Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest describeAccountSettingsRequest, AsyncHandler<DescribeAccountSettingsRequest,DescribeAccountSettingsResult> asyncHandler)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services 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<DescribeAccountSubscriptionResult> describeAccountSubscriptionAsync(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
describeAccountSubscriptionRequest - Future<DescribeAccountSubscriptionResult> describeAccountSubscriptionAsync(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest, AsyncHandler<DescribeAccountSubscriptionRequest,DescribeAccountSubscriptionResult> asyncHandler)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
describeAccountSubscriptionRequest - 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<DescribeAnalysisDefinitionResult> describeAnalysisDefinitionAsync(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis instead.
describeAnalysisDefinitionRequest - Future<DescribeAnalysisDefinitionResult> describeAnalysisDefinitionAsync(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest, AsyncHandler<DescribeAnalysisDefinitionRequest,DescribeAnalysisDefinitionResult> asyncHandler)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis instead.
describeAnalysisDefinitionRequest - 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<DescribeAssetBundleExportJobResult> describeAssetBundleExportJobAsync(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to
download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You
can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
describeAssetBundleExportJobRequest - Future<DescribeAssetBundleExportJobResult> describeAssetBundleExportJobAsync(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest, AsyncHandler<DescribeAssetBundleExportJobRequest,DescribeAssetBundleExportJobResult> asyncHandler)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to
download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You
can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
describeAssetBundleExportJobRequest - 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<DescribeAssetBundleImportJobResult> describeAssetBundleImportJobAsync(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
describeAssetBundleImportJobRequest - Future<DescribeAssetBundleImportJobResult> describeAssetBundleImportJobAsync(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest, AsyncHandler<DescribeAssetBundleImportJobRequest,DescribeAssetBundleImportJobResult> asyncHandler)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
describeAssetBundleImportJobRequest - 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<DescribeDashboardDefinitionResult> describeDashboardDefinitionAsync(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard instead.
describeDashboardDefinitionRequest - Future<DescribeDashboardDefinitionResult> describeDashboardDefinitionAsync(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest, AsyncHandler<DescribeDashboardDefinitionRequest,DescribeDashboardDefinitionResult> asyncHandler)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard instead.
describeDashboardDefinitionRequest - 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. This operation doesn't support datasets that include uploaded files as a source.
describeDataSetRequest - Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest describeDataSetRequest, AsyncHandler<DescribeDataSetRequest,DescribeDataSetResult> asyncHandler)
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
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<DescribeDataSetRefreshPropertiesResult> describeDataSetRefreshPropertiesAsync(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)
Describes the refresh properties of a dataset.
describeDataSetRefreshPropertiesRequest - Future<DescribeDataSetRefreshPropertiesResult> describeDataSetRefreshPropertiesAsync(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest, AsyncHandler<DescribeDataSetRefreshPropertiesRequest,DescribeDataSetRefreshPropertiesResult> asyncHandler)
Describes the refresh properties of a dataset.
describeDataSetRefreshPropertiesRequest - 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<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest describeFolderRequest)
Describes a folder.
describeFolderRequest - Future<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest describeFolderRequest, AsyncHandler<DescribeFolderRequest,DescribeFolderResult> asyncHandler)
Describes a folder.
describeFolderRequest - 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<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
Describes permissions for a folder.
describeFolderPermissionsRequest - Future<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest describeFolderPermissionsRequest, AsyncHandler<DescribeFolderPermissionsRequest,DescribeFolderPermissionsResult> asyncHandler)
Describes permissions for a folder.
describeFolderPermissionsRequest - 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<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsRequest - Future<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest, AsyncHandler<DescribeFolderResolvedPermissionsRequest,DescribeFolderResolvedPermissionsResult> asyncHandler)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsRequest - 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<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember object is
returned.
describeGroupMembershipRequest - Future<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest describeGroupMembershipRequest, AsyncHandler<DescribeGroupMembershipRequest,DescribeGroupMembershipResult> asyncHandler)
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember object is
returned.
describeGroupMembershipRequest - 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<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest describeIpRestrictionRequest)
Provides a summary and status of IP rules.
describeIpRestrictionRequest - Future<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest describeIpRestrictionRequest, AsyncHandler<DescribeIpRestrictionRequest,DescribeIpRestrictionResult> asyncHandler)
Provides a summary and status of IP rules.
describeIpRestrictionRequest - 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<DescribeRefreshScheduleResult> describeRefreshScheduleAsync(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)
Provides a summary of a refresh schedule.
describeRefreshScheduleRequest - Future<DescribeRefreshScheduleResult> describeRefreshScheduleAsync(DescribeRefreshScheduleRequest describeRefreshScheduleRequest, AsyncHandler<DescribeRefreshScheduleRequest,DescribeRefreshScheduleResult> asyncHandler)
Provides a summary of a refresh schedule.
describeRefreshScheduleRequest - 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<DescribeTemplateDefinitionResult> describeTemplateDefinitionAsync(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate instead.
describeTemplateDefinitionRequest - Future<DescribeTemplateDefinitionResult> describeTemplateDefinitionAsync(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest, AsyncHandler<DescribeTemplateDefinitionRequest,DescribeTemplateDefinitionResult> asyncHandler)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate instead.
describeTemplateDefinitionRequest - 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<DescribeTopicResult> describeTopicAsync(DescribeTopicRequest describeTopicRequest)
Describes a topic.
describeTopicRequest - Future<DescribeTopicResult> describeTopicAsync(DescribeTopicRequest describeTopicRequest, AsyncHandler<DescribeTopicRequest,DescribeTopicResult> asyncHandler)
Describes a topic.
describeTopicRequest - 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<DescribeTopicPermissionsResult> describeTopicPermissionsAsync(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)
Describes the permissions of a topic.
describeTopicPermissionsRequest - Future<DescribeTopicPermissionsResult> describeTopicPermissionsAsync(DescribeTopicPermissionsRequest describeTopicPermissionsRequest, AsyncHandler<DescribeTopicPermissionsRequest,DescribeTopicPermissionsResult> asyncHandler)
Describes the permissions of a topic.
describeTopicPermissionsRequest - 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<DescribeTopicRefreshResult> describeTopicRefreshAsync(DescribeTopicRefreshRequest describeTopicRefreshRequest)
Describes the status of a topic refresh.
describeTopicRefreshRequest - Future<DescribeTopicRefreshResult> describeTopicRefreshAsync(DescribeTopicRefreshRequest describeTopicRefreshRequest, AsyncHandler<DescribeTopicRefreshRequest,DescribeTopicRefreshResult> asyncHandler)
Describes the status of a topic refresh.
describeTopicRefreshRequest - 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<DescribeTopicRefreshScheduleResult> describeTopicRefreshScheduleAsync(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
describeTopicRefreshScheduleRequest - Future<DescribeTopicRefreshScheduleResult> describeTopicRefreshScheduleAsync(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest, AsyncHandler<DescribeTopicRefreshScheduleRequest,DescribeTopicRefreshScheduleResult> asyncHandler)
Deletes a topic refresh schedule.
describeTopicRefreshScheduleRequest - 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<DescribeVPCConnectionResult> describeVPCConnectionAsync(DescribeVPCConnectionRequest describeVPCConnectionRequest)
Describes a VPC connection.
describeVPCConnectionRequest - Future<DescribeVPCConnectionResult> describeVPCConnectionAsync(DescribeVPCConnectionRequest describeVPCConnectionRequest, AsyncHandler<DescribeVPCConnectionRequest,DescribeVPCConnectionResult> asyncHandler)
Describes a VPC connection.
describeVPCConnectionRequest - 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<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserRequest - Future<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest, AsyncHandler<GenerateEmbedUrlForAnonymousUserRequest,GenerateEmbedUrlForAnonymousUserResult> asyncHandler)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserRequest - 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<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserRequest - Future<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest, AsyncHandler<GenerateEmbedUrlForRegisteredUserRequest,GenerateEmbedUrlForRegisteredUserResult> asyncHandler)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserRequest - 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 temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
getDashboardEmbedUrlRequest - Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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 Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
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 Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
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 Amazon Web Services account.
listAnalysesRequest - Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest listAnalysesRequest, AsyncHandler<ListAnalysesRequest,ListAnalysesResult> asyncHandler)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services 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<ListAssetBundleExportJobsResult> listAssetBundleExportJobsAsync(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days
ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
listAssetBundleExportJobsRequest - Future<ListAssetBundleExportJobsResult> listAssetBundleExportJobsAsync(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest, AsyncHandler<ListAssetBundleExportJobsRequest,ListAssetBundleExportJobsResult> asyncHandler)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days
ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
listAssetBundleExportJobsRequest - 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<ListAssetBundleImportJobsResult> listAssetBundleImportJobsAsync(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago
are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
listAssetBundleImportJobsRequest - Future<ListAssetBundleImportJobsResult> listAssetBundleImportJobsAsync(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest, AsyncHandler<ListAssetBundleImportJobsRequest,ListAssetBundleImportJobsResult> asyncHandler)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago
are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
listAssetBundleImportJobsRequest - 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 Amazon QuickSight subscription.
listDashboardVersionsRequest - Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest listDashboardVersionsRequest, AsyncHandler<ListDashboardVersionsRequest,ListDashboardVersionsResult> asyncHandler)
Lists all the versions of the dashboards in the Amazon 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 Amazon Web Services account.
listDashboardsRequest - Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest listDashboardsRequest, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
Lists dashboards in an Amazon Web Services 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 Amazon Web Services account in an Amazon Web Services 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 Amazon Web Services account in an Amazon Web Services 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 Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSourcesRequest - Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services 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<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest listFolderMembersRequest)
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolderMembersRequest - Future<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest listFolderMembersRequest, AsyncHandler<ListFolderMembersRequest,ListFolderMembersResult> asyncHandler)
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolderMembersRequest - 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<ListFoldersResult> listFoldersAsync(ListFoldersRequest listFoldersRequest)
Lists all folders in an account.
listFoldersRequest - Future<ListFoldersResult> listFoldersAsync(ListFoldersRequest listFoldersRequest, AsyncHandler<ListFoldersRequest,ListFoldersResult> asyncHandler)
Lists all folders in an account.
listFoldersRequest - 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 the IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsRequest - Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest, AsyncHandler<ListIAMPolicyAssignmentsRequest,ListIAMPolicyAssignmentsResult> asyncHandler)
Lists the 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 of 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 of 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 Amazon Web Services account. This operation doesn't list deleted namespaces.
listNamespacesRequest - Future<ListNamespacesResult> listNamespacesAsync(ListNamespacesRequest listNamespacesRequest, AsyncHandler<ListNamespacesRequest,ListNamespacesResult> asyncHandler)
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
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<ListRefreshSchedulesResult> listRefreshSchedulesAsync(ListRefreshSchedulesRequest listRefreshSchedulesRequest)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
listRefreshSchedulesRequest - Future<ListRefreshSchedulesResult> listRefreshSchedulesAsync(ListRefreshSchedulesRequest listRefreshSchedulesRequest, AsyncHandler<ListRefreshSchedulesRequest,ListRefreshSchedulesResult> asyncHandler)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
listRefreshSchedulesRequest - 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 Amazon Web Services account.
listThemeVersionsRequest - Future<ListThemeVersionsResult> listThemeVersionsAsync(ListThemeVersionsRequest listThemeVersionsRequest, AsyncHandler<ListThemeVersionsRequest,ListThemeVersionsResult> asyncHandler)
Lists all the versions of the themes in the current Amazon Web Services 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 Amazon Web Services account.
listThemesRequest - Future<ListThemesResult> listThemesAsync(ListThemesRequest listThemesRequest, AsyncHandler<ListThemesRequest,ListThemesResult> asyncHandler)
Lists all the themes in the current Amazon Web Services 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<ListTopicRefreshSchedulesResult> listTopicRefreshSchedulesAsync(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)
Lists all of the refresh schedules for a topic.
listTopicRefreshSchedulesRequest - Future<ListTopicRefreshSchedulesResult> listTopicRefreshSchedulesAsync(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest, AsyncHandler<ListTopicRefreshSchedulesRequest,ListTopicRefreshSchedulesResult> asyncHandler)
Lists all of the refresh schedules for a topic.
listTopicRefreshSchedulesRequest - 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<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest)
Lists all of the topics within an account.
listTopicsRequest - Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Lists all of the topics within an account.
listTopicsRequest - 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<ListVPCConnectionsResult> listVPCConnectionsAsync(ListVPCConnectionsRequest listVPCConnectionsRequest)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
listVPCConnectionsRequest - Future<ListVPCConnectionsResult> listVPCConnectionsAsync(ListVPCConnectionsRequest listVPCConnectionsRequest, AsyncHandler<ListVPCConnectionsRequest,ListVPCConnectionsResult> asyncHandler)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
listVPCConnectionsRequest - 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<PutDataSetRefreshPropertiesResult> putDataSetRefreshPropertiesAsync(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)
Creates or updates the dataset refresh properties for the dataset.
putDataSetRefreshPropertiesRequest - Future<PutDataSetRefreshPropertiesResult> putDataSetRefreshPropertiesAsync(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest, AsyncHandler<PutDataSetRefreshPropertiesRequest,PutDataSetRefreshPropertiesResult> asyncHandler)
Creates or updates the dataset refresh properties for the dataset.
putDataSetRefreshPropertiesRequest - 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 Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
registerUserRequest - Future<RegisterUserResult> registerUserAsync(RegisterUserRequest registerUserRequest, AsyncHandler<RegisterUserRequest,RegisterUserResult> asyncHandler)
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalysesRequest - Future<SearchAnalysesResult> searchAnalysesAsync(SearchAnalysesRequest searchAnalysesRequest, AsyncHandler<SearchAnalysesRequest,SearchAnalysesResult> asyncHandler)
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchDashboardsRequest - Future<SearchDashboardsResult> searchDashboardsAsync(SearchDashboardsRequest searchDashboardsRequest, AsyncHandler<SearchDashboardsRequest,SearchDashboardsResult> asyncHandler)
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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<SearchDataSetsResult> searchDataSetsAsync(SearchDataSetsRequest searchDataSetsRequest)
Use the SearchDataSets operation to search for datasets that belong to an account.
searchDataSetsRequest - Future<SearchDataSetsResult> searchDataSetsAsync(SearchDataSetsRequest searchDataSetsRequest, AsyncHandler<SearchDataSetsRequest,SearchDataSetsResult> asyncHandler)
Use the SearchDataSets operation to search for datasets that belong to an account.
searchDataSetsRequest - 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<SearchDataSourcesResult> searchDataSourcesAsync(SearchDataSourcesRequest searchDataSourcesRequest)
Use the SearchDataSources operation to search for data sources that belong to an account.
searchDataSourcesRequest - Future<SearchDataSourcesResult> searchDataSourcesAsync(SearchDataSourcesRequest searchDataSourcesRequest, AsyncHandler<SearchDataSourcesRequest,SearchDataSourcesResult> asyncHandler)
Use the SearchDataSources operation to search for data sources that belong to an account.
searchDataSourcesRequest - 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<SearchFoldersResult> searchFoldersAsync(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
searchFoldersRequest - Future<SearchFoldersResult> searchFoldersAsync(SearchFoldersRequest searchFoldersRequest, AsyncHandler<SearchFoldersRequest,SearchFoldersResult> asyncHandler)
Searches the subfolders in a folder.
searchFoldersRequest - 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<SearchGroupsResult> searchGroupsAsync(SearchGroupsRequest searchGroupsRequest)
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsRequest - Future<SearchGroupsResult> searchGroupsAsync(SearchGroupsRequest searchGroupsRequest, AsyncHandler<SearchGroupsRequest,SearchGroupsResult> asyncHandler)
Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsRequest - 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<StartAssetBundleExportJobResult> startAssetBundleExportJobAsync(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset
dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that
contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 10 export jobs
concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
startAssetBundleExportJobRequest - Future<StartAssetBundleExportJobResult> startAssetBundleExportJobAsync(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest, AsyncHandler<StartAssetBundleExportJobRequest,StartAssetBundleExportJobResult> asyncHandler)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset
dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that
contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 10 export jobs
concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
startAssetBundleExportJobRequest - 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<StartAssetBundleImportJobResult> startAssetBundleImportJobAsync(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 10 import jobs concurrently.
The API caller must have the necessary "create", "describe", and "update"
permissions in their IAM role to access each resource type that is contained in the bundle file before the
resources can be imported.
startAssetBundleImportJobRequest - Future<StartAssetBundleImportJobResult> startAssetBundleImportJobAsync(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest, AsyncHandler<StartAssetBundleImportJobRequest,StartAssetBundleImportJobResult> asyncHandler)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 10 import jobs concurrently.
The API caller must have the necessary "create", "describe", and "update"
permissions in their IAM role to access each resource type that is contained in the bundle file before the
resources can be imported.
startAssetBundleImportJobRequest - 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 Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, and topic.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, and topic.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
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 for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
updateAccountCustomizationRequest - Future<UpdateAccountCustomizationResult> updateAccountCustomizationAsync(UpdateAccountCustomizationRequest updateAccountCustomizationRequest, AsyncHandler<UpdateAccountCustomizationRequest,UpdateAccountCustomizationResult> asyncHandler)
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
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 Amazon Web Services account.
updateAccountSettingsRequest - Future<UpdateAccountSettingsResult> updateAccountSettingsAsync(UpdateAccountSettingsRequest updateAccountSettingsRequest, AsyncHandler<UpdateAccountSettingsRequest,UpdateAccountSettingsResult> asyncHandler)
Updates the Amazon QuickSight settings in your Amazon Web Services 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 Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
updateDashboardRequest - Future<UpdateDashboardResult> updateDashboardAsync(UpdateDashboardRequest updateDashboardRequest, AsyncHandler<UpdateDashboardRequest,UpdateDashboardResult> asyncHandler)
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can
update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.
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. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
updateDataSetRequest - Future<UpdateDataSetResult> updateDataSetAsync(UpdateDataSetRequest updateDataSetRequest, AsyncHandler<UpdateDataSetRequest,UpdateDataSetResult> asyncHandler)
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
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<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest updateFolderRequest)
Updates the name of a folder.
updateFolderRequest - Future<UpdateFolderResult> updateFolderAsync(UpdateFolderRequest updateFolderRequest, AsyncHandler<UpdateFolderRequest,UpdateFolderResult> asyncHandler)
Updates the name of a folder.
updateFolderRequest - 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<UpdateFolderPermissionsResult> updateFolderPermissionsAsync(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
Updates permissions of a folder.
updateFolderPermissionsRequest - Future<UpdateFolderPermissionsResult> updateFolderPermissionsAsync(UpdateFolderPermissionsRequest updateFolderPermissionsRequest, AsyncHandler<UpdateFolderPermissionsRequest,UpdateFolderPermissionsResult> asyncHandler)
Updates permissions of a folder.
updateFolderPermissionsRequest - 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. This overwrites all of the users included in Identities.
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. This overwrites all of the users included in Identities.
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<UpdateIpRestrictionResult> updateIpRestrictionAsync(UpdateIpRestrictionRequest updateIpRestrictionRequest)
Updates the content and status of IP rules. To use this operation, you must provide the entire map of rules. You
can use the DescribeIpRestriction operation to get the current rule map.
updateIpRestrictionRequest - Future<UpdateIpRestrictionResult> updateIpRestrictionAsync(UpdateIpRestrictionRequest updateIpRestrictionRequest, AsyncHandler<UpdateIpRestrictionRequest,UpdateIpRestrictionResult> asyncHandler)
Updates the content and status of IP rules. To use this operation, you must provide the entire map of rules. You
can use the DescribeIpRestriction operation to get the current rule map.
updateIpRestrictionRequest - 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<UpdatePublicSharingSettingsResult> updatePublicSharingSettingsAsync(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
updatePublicSharingSettingsRequest - Future<UpdatePublicSharingSettingsResult> updatePublicSharingSettingsAsync(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest, AsyncHandler<UpdatePublicSharingSettingsRequest,UpdatePublicSharingSettingsResult> asyncHandler)
Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
updatePublicSharingSettingsRequest - 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<UpdateRefreshScheduleResult> updateRefreshScheduleAsync(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)
Updates a refresh schedule for a dataset.
updateRefreshScheduleRequest - Future<UpdateRefreshScheduleResult> updateRefreshScheduleAsync(UpdateRefreshScheduleRequest updateRefreshScheduleRequest, AsyncHandler<UpdateRefreshScheduleRequest,UpdateRefreshScheduleResult> asyncHandler)
Updates a refresh schedule for a dataset.
updateRefreshScheduleRequest - 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 -