@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonQuickSightAsync extends AbstractAmazonQuickSight implements AmazonQuickSightAsync
AmazonQuickSightAsync
. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
cancelIngestion, 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, updateVPCConnection
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelIngestion, 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, updateVPCConnection
public Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request)
AmazonQuickSightAsync
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionAsync
in interface AmazonQuickSightAsync
public Future<CancelIngestionResult> cancelIngestionAsync(CancelIngestionRequest request, AsyncHandler<CancelIngestionRequest,CancelIngestionResult> asyncHandler)
AmazonQuickSightAsync
Cancels an ongoing ingestion of data into SPICE.
cancelIngestionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest request)
AmazonQuickSightAsync
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.
createAccountCustomizationAsync
in interface AmazonQuickSightAsync
public Future<CreateAccountCustomizationResult> createAccountCustomizationAsync(CreateAccountCustomizationRequest request, AsyncHandler<CreateAccountCustomizationRequest,CreateAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsync
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.
createAccountCustomizationAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAccountSubscriptionResult> createAccountSubscriptionAsync(CreateAccountSubscriptionRequest request)
AmazonQuickSightAsync
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.
createAccountSubscriptionAsync
in interface AmazonQuickSightAsync
public Future<CreateAccountSubscriptionResult> createAccountSubscriptionAsync(CreateAccountSubscriptionRequest request, AsyncHandler<CreateAccountSubscriptionRequest,CreateAccountSubscriptionResult> asyncHandler)
AmazonQuickSightAsync
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.
createAccountSubscriptionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest request)
AmazonQuickSightAsync
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
createAnalysisAsync
in interface AmazonQuickSightAsync
public Future<CreateAnalysisResult> createAnalysisAsync(CreateAnalysisRequest request, AsyncHandler<CreateAnalysisRequest,CreateAnalysisResult> asyncHandler)
AmazonQuickSightAsync
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
createAnalysisAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest request)
AmazonQuickSightAsync
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.
createDashboardAsync
in interface AmazonQuickSightAsync
public Future<CreateDashboardResult> createDashboardAsync(CreateDashboardRequest request, AsyncHandler<CreateDashboardRequest,CreateDashboardResult> asyncHandler)
AmazonQuickSightAsync
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.
createDashboardAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest request)
AmazonQuickSightAsync
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
createDataSetAsync
in interface AmazonQuickSightAsync
public Future<CreateDataSetResult> createDataSetAsync(CreateDataSetRequest request, AsyncHandler<CreateDataSetRequest,CreateDataSetResult> asyncHandler)
AmazonQuickSightAsync
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
createDataSetAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request)
AmazonQuickSightAsync
Creates a data source.
createDataSourceAsync
in interface AmazonQuickSightAsync
public Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
AmazonQuickSightAsync
Creates a data source.
createDataSourceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request)
AmazonQuickSightAsync
Creates an empty shared folder.
createFolderAsync
in interface AmazonQuickSightAsync
public Future<CreateFolderResult> createFolderAsync(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResult> asyncHandler)
AmazonQuickSightAsync
Creates an empty shared folder.
createFolderAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest request)
AmazonQuickSightAsync
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipAsync
in interface AmazonQuickSightAsync
public Future<CreateFolderMembershipResult> createFolderMembershipAsync(CreateFolderMembershipRequest request, AsyncHandler<CreateFolderMembershipRequest,CreateFolderMembershipResult> asyncHandler)
AmazonQuickSightAsync
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AmazonQuickSightAsync
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.
createGroupAsync
in interface AmazonQuickSightAsync
request
- The request object for this operation.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AmazonQuickSightAsync
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.
createGroupAsync
in interface AmazonQuickSightAsync
request
- The request object for this operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request)
AmazonQuickSightAsync
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembershipAsync
in interface AmazonQuickSightAsync
public Future<CreateGroupMembershipResult> createGroupMembershipAsync(CreateGroupMembershipRequest request, AsyncHandler<CreateGroupMembershipRequest,CreateGroupMembershipResult> asyncHandler)
AmazonQuickSightAsync
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembershipAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest request)
AmazonQuickSightAsync
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.
createIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
public Future<CreateIAMPolicyAssignmentResult> createIAMPolicyAssignmentAsync(CreateIAMPolicyAssignmentRequest request, AsyncHandler<CreateIAMPolicyAssignmentRequest,CreateIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsync
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.
createIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest request)
AmazonQuickSightAsync
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.
createIngestionAsync
in interface AmazonQuickSightAsync
public Future<CreateIngestionResult> createIngestionAsync(CreateIngestionRequest request, AsyncHandler<CreateIngestionRequest,CreateIngestionResult> asyncHandler)
AmazonQuickSightAsync
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.
createIngestionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest request)
AmazonQuickSightAsync
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
createNamespaceAsync
in interface AmazonQuickSightAsync
public Future<CreateNamespaceResult> createNamespaceAsync(CreateNamespaceRequest request, AsyncHandler<CreateNamespaceRequest,CreateNamespaceResult> asyncHandler)
AmazonQuickSightAsync
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
createNamespaceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateRefreshScheduleResult> createRefreshScheduleAsync(CreateRefreshScheduleRequest request)
AmazonQuickSightAsync
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<CreateRefreshScheduleResult> createRefreshScheduleAsync(CreateRefreshScheduleRequest request, AsyncHandler<CreateRefreshScheduleRequest,CreateRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request)
AmazonQuickSightAsync
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.
createTemplateAsync
in interface AmazonQuickSightAsync
public Future<CreateTemplateResult> createTemplateAsync(CreateTemplateRequest request, AsyncHandler<CreateTemplateRequest,CreateTemplateResult> asyncHandler)
AmazonQuickSightAsync
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.
createTemplateAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest request)
AmazonQuickSightAsync
Creates a template alias for a template.
createTemplateAliasAsync
in interface AmazonQuickSightAsync
public Future<CreateTemplateAliasResult> createTemplateAliasAsync(CreateTemplateAliasRequest request, AsyncHandler<CreateTemplateAliasRequest,CreateTemplateAliasResult> asyncHandler)
AmazonQuickSightAsync
Creates a template alias for a template.
createTemplateAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateThemeResult> createThemeAsync(CreateThemeRequest request)
AmazonQuickSightAsync
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.
createThemeAsync
in interface AmazonQuickSightAsync
public Future<CreateThemeResult> createThemeAsync(CreateThemeRequest request, AsyncHandler<CreateThemeRequest,CreateThemeResult> asyncHandler)
AmazonQuickSightAsync
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.
createThemeAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest request)
AmazonQuickSightAsync
Creates a theme alias for a theme.
createThemeAliasAsync
in interface AmazonQuickSightAsync
public Future<CreateThemeAliasResult> createThemeAliasAsync(CreateThemeAliasRequest request, AsyncHandler<CreateThemeAliasRequest,CreateThemeAliasResult> asyncHandler)
AmazonQuickSightAsync
Creates a theme alias for a theme.
createThemeAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest request)
AmazonQuickSightAsync
Creates a new Q topic.
createTopicAsync
in interface AmazonQuickSightAsync
public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest request, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
AmazonQuickSightAsync
Creates a new Q topic.
createTopicAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTopicRefreshScheduleResult> createTopicRefreshScheduleAsync(CreateTopicRefreshScheduleRequest request)
AmazonQuickSightAsync
Creates a topic refresh schedule.
createTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<CreateTopicRefreshScheduleResult> createTopicRefreshScheduleAsync(CreateTopicRefreshScheduleRequest request, AsyncHandler<CreateTopicRefreshScheduleRequest,CreateTopicRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Creates a topic refresh schedule.
createTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateVPCConnectionResult> createVPCConnectionAsync(CreateVPCConnectionRequest request)
AmazonQuickSightAsync
Creates a new VPC connection.
createVPCConnectionAsync
in interface AmazonQuickSightAsync
public Future<CreateVPCConnectionResult> createVPCConnectionAsync(CreateVPCConnectionRequest request, AsyncHandler<CreateVPCConnectionRequest,CreateVPCConnectionResult> asyncHandler)
AmazonQuickSightAsync
Creates a new VPC connection.
createVPCConnectionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest request)
AmazonQuickSightAsync
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomizationAsync
in interface AmazonQuickSightAsync
public Future<DeleteAccountCustomizationResult> deleteAccountCustomizationAsync(DeleteAccountCustomizationRequest request, AsyncHandler<DeleteAccountCustomizationRequest,DeleteAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsync
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomizationAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAccountSubscriptionResult> deleteAccountSubscriptionAsync(DeleteAccountSubscriptionRequest request)
AmazonQuickSightAsync
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.
deleteAccountSubscriptionAsync
in interface AmazonQuickSightAsync
public Future<DeleteAccountSubscriptionResult> deleteAccountSubscriptionAsync(DeleteAccountSubscriptionRequest request, AsyncHandler<DeleteAccountSubscriptionRequest,DeleteAccountSubscriptionResult> asyncHandler)
AmazonQuickSightAsync
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.
deleteAccountSubscriptionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest request)
AmazonQuickSightAsync
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon
QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the
DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisAsync
in interface AmazonQuickSightAsync
public Future<DeleteAnalysisResult> deleteAnalysisAsync(DeleteAnalysisRequest request, AsyncHandler<DeleteAnalysisRequest,DeleteAnalysisResult> asyncHandler)
AmazonQuickSightAsync
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon
QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the
DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest request)
AmazonQuickSightAsync
Deletes a dashboard.
deleteDashboardAsync
in interface AmazonQuickSightAsync
public Future<DeleteDashboardResult> deleteDashboardAsync(DeleteDashboardRequest request, AsyncHandler<DeleteDashboardRequest,DeleteDashboardResult> asyncHandler)
AmazonQuickSightAsync
Deletes a dashboard.
deleteDashboardAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest request)
AmazonQuickSightAsync
Deletes a dataset.
deleteDataSetAsync
in interface AmazonQuickSightAsync
public Future<DeleteDataSetResult> deleteDataSetAsync(DeleteDataSetRequest request, AsyncHandler<DeleteDataSetRequest,DeleteDataSetResult> asyncHandler)
AmazonQuickSightAsync
Deletes a dataset.
deleteDataSetAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSetRefreshPropertiesResult> deleteDataSetRefreshPropertiesAsync(DeleteDataSetRefreshPropertiesRequest request)
AmazonQuickSightAsync
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshPropertiesAsync
in interface AmazonQuickSightAsync
public Future<DeleteDataSetRefreshPropertiesResult> deleteDataSetRefreshPropertiesAsync(DeleteDataSetRefreshPropertiesRequest request, AsyncHandler<DeleteDataSetRefreshPropertiesRequest,DeleteDataSetRefreshPropertiesResult> asyncHandler)
AmazonQuickSightAsync
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshPropertiesAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request)
AmazonQuickSightAsync
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSourceAsync
in interface AmazonQuickSightAsync
public Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
AmazonQuickSightAsync
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSourceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request)
AmazonQuickSightAsync
Deletes an empty folder.
deleteFolderAsync
in interface AmazonQuickSightAsync
public Future<DeleteFolderResult> deleteFolderAsync(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResult> asyncHandler)
AmazonQuickSightAsync
Deletes an empty folder.
deleteFolderAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest request)
AmazonQuickSightAsync
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipAsync
in interface AmazonQuickSightAsync
public Future<DeleteFolderMembershipResult> deleteFolderMembershipAsync(DeleteFolderMembershipRequest request, AsyncHandler<DeleteFolderMembershipRequest,DeleteFolderMembershipResult> asyncHandler)
AmazonQuickSightAsync
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AmazonQuickSightAsync
Removes a user group from Amazon QuickSight.
deleteGroupAsync
in interface AmazonQuickSightAsync
public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AmazonQuickSightAsync
Removes a user group from Amazon QuickSight.
deleteGroupAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request)
AmazonQuickSightAsync
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembershipAsync
in interface AmazonQuickSightAsync
public Future<DeleteGroupMembershipResult> deleteGroupMembershipAsync(DeleteGroupMembershipRequest request, AsyncHandler<DeleteGroupMembershipRequest,DeleteGroupMembershipResult> asyncHandler)
AmazonQuickSightAsync
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembershipAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest request)
AmazonQuickSightAsync
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
public Future<DeleteIAMPolicyAssignmentResult> deleteIAMPolicyAssignmentAsync(DeleteIAMPolicyAssignmentRequest request, AsyncHandler<DeleteIAMPolicyAssignmentRequest,DeleteIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsync
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest request)
AmazonQuickSightAsync
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.
deleteNamespaceAsync
in interface AmazonQuickSightAsync
public Future<DeleteNamespaceResult> deleteNamespaceAsync(DeleteNamespaceRequest request, AsyncHandler<DeleteNamespaceRequest,DeleteNamespaceResult> asyncHandler)
AmazonQuickSightAsync
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.
deleteNamespaceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRefreshScheduleResult> deleteRefreshScheduleAsync(DeleteRefreshScheduleRequest request)
AmazonQuickSightAsync
Deletes a refresh schedule from a dataset.
deleteRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<DeleteRefreshScheduleResult> deleteRefreshScheduleAsync(DeleteRefreshScheduleRequest request, AsyncHandler<DeleteRefreshScheduleRequest,DeleteRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Deletes a refresh schedule from a dataset.
deleteRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request)
AmazonQuickSightAsync
Deletes a template.
deleteTemplateAsync
in interface AmazonQuickSightAsync
public Future<DeleteTemplateResult> deleteTemplateAsync(DeleteTemplateRequest request, AsyncHandler<DeleteTemplateRequest,DeleteTemplateResult> asyncHandler)
AmazonQuickSightAsync
Deletes a template.
deleteTemplateAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest request)
AmazonQuickSightAsync
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.
deleteTemplateAliasAsync
in interface AmazonQuickSightAsync
public Future<DeleteTemplateAliasResult> deleteTemplateAliasAsync(DeleteTemplateAliasRequest request, AsyncHandler<DeleteTemplateAliasRequest,DeleteTemplateAliasResult> asyncHandler)
AmazonQuickSightAsync
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.
deleteTemplateAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest request)
AmazonQuickSightAsync
Deletes a theme.
deleteThemeAsync
in interface AmazonQuickSightAsync
public Future<DeleteThemeResult> deleteThemeAsync(DeleteThemeRequest request, AsyncHandler<DeleteThemeRequest,DeleteThemeResult> asyncHandler)
AmazonQuickSightAsync
Deletes a theme.
deleteThemeAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest request)
AmazonQuickSightAsync
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.
deleteThemeAliasAsync
in interface AmazonQuickSightAsync
public Future<DeleteThemeAliasResult> deleteThemeAliasAsync(DeleteThemeAliasRequest request, AsyncHandler<DeleteThemeAliasRequest,DeleteThemeAliasResult> asyncHandler)
AmazonQuickSightAsync
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.
deleteThemeAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest request)
AmazonQuickSightAsync
Deletes a topic.
deleteTopicAsync
in interface AmazonQuickSightAsync
public Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest request, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
AmazonQuickSightAsync
Deletes a topic.
deleteTopicAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTopicRefreshScheduleResult> deleteTopicRefreshScheduleAsync(DeleteTopicRefreshScheduleRequest request)
AmazonQuickSightAsync
Deletes a topic refresh schedule.
deleteTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<DeleteTopicRefreshScheduleResult> deleteTopicRefreshScheduleAsync(DeleteTopicRefreshScheduleRequest request, AsyncHandler<DeleteTopicRefreshScheduleRequest,DeleteTopicRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Deletes a topic refresh schedule.
deleteTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonQuickSightAsync
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.
deleteUserAsync
in interface AmazonQuickSightAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonQuickSightAsync
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.
deleteUserAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request)
AmazonQuickSightAsync
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdAsync
in interface AmazonQuickSightAsync
public Future<DeleteUserByPrincipalIdResult> deleteUserByPrincipalIdAsync(DeleteUserByPrincipalIdRequest request, AsyncHandler<DeleteUserByPrincipalIdRequest,DeleteUserByPrincipalIdResult> asyncHandler)
AmazonQuickSightAsync
Deletes a user identified by its principal ID.
deleteUserByPrincipalIdAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteVPCConnectionResult> deleteVPCConnectionAsync(DeleteVPCConnectionRequest request)
AmazonQuickSightAsync
Deletes a VPC connection.
deleteVPCConnectionAsync
in interface AmazonQuickSightAsync
public Future<DeleteVPCConnectionResult> deleteVPCConnectionAsync(DeleteVPCConnectionRequest request, AsyncHandler<DeleteVPCConnectionRequest,DeleteVPCConnectionResult> asyncHandler)
AmazonQuickSightAsync
Deletes a VPC connection.
deleteVPCConnectionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest request)
AmazonQuickSightAsync
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the
same customizations.
describeAccountCustomizationAsync
in interface AmazonQuickSightAsync
public Future<DescribeAccountCustomizationResult> describeAccountCustomizationAsync(DescribeAccountCustomizationRequest request, AsyncHandler<DescribeAccountCustomizationRequest,DescribeAccountCustomizationResult> asyncHandler)
AmazonQuickSightAsync
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the
CreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the
same customizations.
describeAccountCustomizationAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest request)
AmazonQuickSightAsync
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettingsAsync
in interface AmazonQuickSightAsync
public Future<DescribeAccountSettingsResult> describeAccountSettingsAsync(DescribeAccountSettingsRequest request, AsyncHandler<DescribeAccountSettingsRequest,DescribeAccountSettingsResult> asyncHandler)
AmazonQuickSightAsync
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettingsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountSubscriptionResult> describeAccountSubscriptionAsync(DescribeAccountSubscriptionRequest request)
AmazonQuickSightAsync
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.
describeAccountSubscriptionAsync
in interface AmazonQuickSightAsync
public Future<DescribeAccountSubscriptionResult> describeAccountSubscriptionAsync(DescribeAccountSubscriptionRequest request, AsyncHandler<DescribeAccountSubscriptionRequest,DescribeAccountSubscriptionResult> asyncHandler)
AmazonQuickSightAsync
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.
describeAccountSubscriptionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest request)
AmazonQuickSightAsync
Provides a summary of the metadata for an analysis.
describeAnalysisAsync
in interface AmazonQuickSightAsync
public Future<DescribeAnalysisResult> describeAnalysisAsync(DescribeAnalysisRequest request, AsyncHandler<DescribeAnalysisRequest,DescribeAnalysisResult> asyncHandler)
AmazonQuickSightAsync
Provides a summary of the metadata for an analysis.
describeAnalysisAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAnalysisDefinitionResult> describeAnalysisDefinitionAsync(DescribeAnalysisDefinitionRequest request)
AmazonQuickSightAsync
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.
describeAnalysisDefinitionAsync
in interface AmazonQuickSightAsync
public Future<DescribeAnalysisDefinitionResult> describeAnalysisDefinitionAsync(DescribeAnalysisDefinitionRequest request, AsyncHandler<DescribeAnalysisDefinitionRequest,DescribeAnalysisDefinitionResult> asyncHandler)
AmazonQuickSightAsync
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.
describeAnalysisDefinitionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest request)
AmazonQuickSightAsync
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeAnalysisPermissionsResult> describeAnalysisPermissionsAsync(DescribeAnalysisPermissionsRequest request, AsyncHandler<DescribeAnalysisPermissionsRequest,DescribeAnalysisPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAssetBundleExportJobResult> describeAssetBundleExportJobAsync(DescribeAssetBundleExportJobRequest request)
AmazonQuickSightAsync
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.
describeAssetBundleExportJobAsync
in interface AmazonQuickSightAsync
public Future<DescribeAssetBundleExportJobResult> describeAssetBundleExportJobAsync(DescribeAssetBundleExportJobRequest request, AsyncHandler<DescribeAssetBundleExportJobRequest,DescribeAssetBundleExportJobResult> asyncHandler)
AmazonQuickSightAsync
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.
describeAssetBundleExportJobAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAssetBundleImportJobResult> describeAssetBundleImportJobAsync(DescribeAssetBundleImportJobRequest request)
AmazonQuickSightAsync
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.
describeAssetBundleImportJobAsync
in interface AmazonQuickSightAsync
public Future<DescribeAssetBundleImportJobResult> describeAssetBundleImportJobAsync(DescribeAssetBundleImportJobRequest request, AsyncHandler<DescribeAssetBundleImportJobRequest,DescribeAssetBundleImportJobResult> asyncHandler)
AmazonQuickSightAsync
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.
describeAssetBundleImportJobAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest request)
AmazonQuickSightAsync
Provides a summary for a dashboard.
describeDashboardAsync
in interface AmazonQuickSightAsync
public Future<DescribeDashboardResult> describeDashboardAsync(DescribeDashboardRequest request, AsyncHandler<DescribeDashboardRequest,DescribeDashboardResult> asyncHandler)
AmazonQuickSightAsync
Provides a summary for a dashboard.
describeDashboardAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDashboardDefinitionResult> describeDashboardDefinitionAsync(DescribeDashboardDefinitionRequest request)
AmazonQuickSightAsync
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.
describeDashboardDefinitionAsync
in interface AmazonQuickSightAsync
public Future<DescribeDashboardDefinitionResult> describeDashboardDefinitionAsync(DescribeDashboardDefinitionRequest request, AsyncHandler<DescribeDashboardDefinitionRequest,DescribeDashboardDefinitionResult> asyncHandler)
AmazonQuickSightAsync
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.
describeDashboardDefinitionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest request)
AmazonQuickSightAsync
Describes read and write permissions for a dashboard.
describeDashboardPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeDashboardPermissionsResult> describeDashboardPermissionsAsync(DescribeDashboardPermissionsRequest request, AsyncHandler<DescribeDashboardPermissionsRequest,DescribeDashboardPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes read and write permissions for a dashboard.
describeDashboardPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest request)
AmazonQuickSightAsync
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
describeDataSetAsync
in interface AmazonQuickSightAsync
public Future<DescribeDataSetResult> describeDataSetAsync(DescribeDataSetRequest request, AsyncHandler<DescribeDataSetRequest,DescribeDataSetResult> asyncHandler)
AmazonQuickSightAsync
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
describeDataSetAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest request)
AmazonQuickSightAsync
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
describeDataSetPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeDataSetPermissionsResult> describeDataSetPermissionsAsync(DescribeDataSetPermissionsRequest request, AsyncHandler<DescribeDataSetPermissionsRequest,DescribeDataSetPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
describeDataSetPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSetRefreshPropertiesResult> describeDataSetRefreshPropertiesAsync(DescribeDataSetRefreshPropertiesRequest request)
AmazonQuickSightAsync
Describes the refresh properties of a dataset.
describeDataSetRefreshPropertiesAsync
in interface AmazonQuickSightAsync
public Future<DescribeDataSetRefreshPropertiesResult> describeDataSetRefreshPropertiesAsync(DescribeDataSetRefreshPropertiesRequest request, AsyncHandler<DescribeDataSetRefreshPropertiesRequest,DescribeDataSetRefreshPropertiesResult> asyncHandler)
AmazonQuickSightAsync
Describes the refresh properties of a dataset.
describeDataSetRefreshPropertiesAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request)
AmazonQuickSightAsync
Describes a data source.
describeDataSourceAsync
in interface AmazonQuickSightAsync
public Future<DescribeDataSourceResult> describeDataSourceAsync(DescribeDataSourceRequest request, AsyncHandler<DescribeDataSourceRequest,DescribeDataSourceResult> asyncHandler)
AmazonQuickSightAsync
Describes a data source.
describeDataSourceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest request)
AmazonQuickSightAsync
Describes the resource permissions for a data source.
describeDataSourcePermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeDataSourcePermissionsResult> describeDataSourcePermissionsAsync(DescribeDataSourcePermissionsRequest request, AsyncHandler<DescribeDataSourcePermissionsRequest,DescribeDataSourcePermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes the resource permissions for a data source.
describeDataSourcePermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest request)
AmazonQuickSightAsync
Describes a folder.
describeFolderAsync
in interface AmazonQuickSightAsync
public Future<DescribeFolderResult> describeFolderAsync(DescribeFolderRequest request, AsyncHandler<DescribeFolderRequest,DescribeFolderResult> asyncHandler)
AmazonQuickSightAsync
Describes a folder.
describeFolderAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest request)
AmazonQuickSightAsync
Describes permissions for a folder.
describeFolderPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeFolderPermissionsResult> describeFolderPermissionsAsync(DescribeFolderPermissionsRequest request, AsyncHandler<DescribeFolderPermissionsRequest,DescribeFolderPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes permissions for a folder.
describeFolderPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest request)
AmazonQuickSightAsync
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeFolderResolvedPermissionsResult> describeFolderResolvedPermissionsAsync(DescribeFolderResolvedPermissionsRequest request, AsyncHandler<DescribeFolderResolvedPermissionsRequest,DescribeFolderResolvedPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request)
AmazonQuickSightAsync
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroupAsync
in interface AmazonQuickSightAsync
public Future<DescribeGroupResult> describeGroupAsync(DescribeGroupRequest request, AsyncHandler<DescribeGroupRequest,DescribeGroupResult> asyncHandler)
AmazonQuickSightAsync
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroupAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest request)
AmazonQuickSightAsync
Use the DescribeGroupMembership
operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember
object is
returned.
describeGroupMembershipAsync
in interface AmazonQuickSightAsync
public Future<DescribeGroupMembershipResult> describeGroupMembershipAsync(DescribeGroupMembershipRequest request, AsyncHandler<DescribeGroupMembershipRequest,DescribeGroupMembershipResult> asyncHandler)
AmazonQuickSightAsync
Use the DescribeGroupMembership
operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember
object is
returned.
describeGroupMembershipAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest request)
AmazonQuickSightAsync
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
public Future<DescribeIAMPolicyAssignmentResult> describeIAMPolicyAssignmentAsync(DescribeIAMPolicyAssignmentRequest request, AsyncHandler<DescribeIAMPolicyAssignmentRequest,DescribeIAMPolicyAssignmentResult> asyncHandler)
AmazonQuickSightAsync
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignmentAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest request)
AmazonQuickSightAsync
Describes a SPICE ingestion.
describeIngestionAsync
in interface AmazonQuickSightAsync
public Future<DescribeIngestionResult> describeIngestionAsync(DescribeIngestionRequest request, AsyncHandler<DescribeIngestionRequest,DescribeIngestionResult> asyncHandler)
AmazonQuickSightAsync
Describes a SPICE ingestion.
describeIngestionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest request)
AmazonQuickSightAsync
Provides a summary and status of IP rules.
describeIpRestrictionAsync
in interface AmazonQuickSightAsync
public Future<DescribeIpRestrictionResult> describeIpRestrictionAsync(DescribeIpRestrictionRequest request, AsyncHandler<DescribeIpRestrictionRequest,DescribeIpRestrictionResult> asyncHandler)
AmazonQuickSightAsync
Provides a summary and status of IP rules.
describeIpRestrictionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest request)
AmazonQuickSightAsync
Describes the current namespace.
describeNamespaceAsync
in interface AmazonQuickSightAsync
public Future<DescribeNamespaceResult> describeNamespaceAsync(DescribeNamespaceRequest request, AsyncHandler<DescribeNamespaceRequest,DescribeNamespaceResult> asyncHandler)
AmazonQuickSightAsync
Describes the current namespace.
describeNamespaceAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRefreshScheduleResult> describeRefreshScheduleAsync(DescribeRefreshScheduleRequest request)
AmazonQuickSightAsync
Provides a summary of a refresh schedule.
describeRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<DescribeRefreshScheduleResult> describeRefreshScheduleAsync(DescribeRefreshScheduleRequest request, AsyncHandler<DescribeRefreshScheduleRequest,DescribeRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Provides a summary of a refresh schedule.
describeRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest request)
AmazonQuickSightAsync
Describes a template's metadata.
describeTemplateAsync
in interface AmazonQuickSightAsync
public Future<DescribeTemplateResult> describeTemplateAsync(DescribeTemplateRequest request, AsyncHandler<DescribeTemplateRequest,DescribeTemplateResult> asyncHandler)
AmazonQuickSightAsync
Describes a template's metadata.
describeTemplateAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest request)
AmazonQuickSightAsync
Describes the template alias for a template.
describeTemplateAliasAsync
in interface AmazonQuickSightAsync
public Future<DescribeTemplateAliasResult> describeTemplateAliasAsync(DescribeTemplateAliasRequest request, AsyncHandler<DescribeTemplateAliasRequest,DescribeTemplateAliasResult> asyncHandler)
AmazonQuickSightAsync
Describes the template alias for a template.
describeTemplateAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplateDefinitionResult> describeTemplateDefinitionAsync(DescribeTemplateDefinitionRequest request)
AmazonQuickSightAsync
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.
describeTemplateDefinitionAsync
in interface AmazonQuickSightAsync
public Future<DescribeTemplateDefinitionResult> describeTemplateDefinitionAsync(DescribeTemplateDefinitionRequest request, AsyncHandler<DescribeTemplateDefinitionRequest,DescribeTemplateDefinitionResult> asyncHandler)
AmazonQuickSightAsync
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.
describeTemplateDefinitionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest request)
AmazonQuickSightAsync
Describes read and write permissions on a template.
describeTemplatePermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeTemplatePermissionsResult> describeTemplatePermissionsAsync(DescribeTemplatePermissionsRequest request, AsyncHandler<DescribeTemplatePermissionsRequest,DescribeTemplatePermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes read and write permissions on a template.
describeTemplatePermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest request)
AmazonQuickSightAsync
Describes a theme.
describeThemeAsync
in interface AmazonQuickSightAsync
public Future<DescribeThemeResult> describeThemeAsync(DescribeThemeRequest request, AsyncHandler<DescribeThemeRequest,DescribeThemeResult> asyncHandler)
AmazonQuickSightAsync
Describes a theme.
describeThemeAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest request)
AmazonQuickSightAsync
Describes the alias for a theme.
describeThemeAliasAsync
in interface AmazonQuickSightAsync
public Future<DescribeThemeAliasResult> describeThemeAliasAsync(DescribeThemeAliasRequest request, AsyncHandler<DescribeThemeAliasRequest,DescribeThemeAliasResult> asyncHandler)
AmazonQuickSightAsync
Describes the alias for a theme.
describeThemeAliasAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest request)
AmazonQuickSightAsync
Describes the read and write permissions for a theme.
describeThemePermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeThemePermissionsResult> describeThemePermissionsAsync(DescribeThemePermissionsRequest request, AsyncHandler<DescribeThemePermissionsRequest,DescribeThemePermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes the read and write permissions for a theme.
describeThemePermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTopicResult> describeTopicAsync(DescribeTopicRequest request)
AmazonQuickSightAsync
Describes a topic.
describeTopicAsync
in interface AmazonQuickSightAsync
public Future<DescribeTopicResult> describeTopicAsync(DescribeTopicRequest request, AsyncHandler<DescribeTopicRequest,DescribeTopicResult> asyncHandler)
AmazonQuickSightAsync
Describes a topic.
describeTopicAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTopicPermissionsResult> describeTopicPermissionsAsync(DescribeTopicPermissionsRequest request)
AmazonQuickSightAsync
Describes the permissions of a topic.
describeTopicPermissionsAsync
in interface AmazonQuickSightAsync
public Future<DescribeTopicPermissionsResult> describeTopicPermissionsAsync(DescribeTopicPermissionsRequest request, AsyncHandler<DescribeTopicPermissionsRequest,DescribeTopicPermissionsResult> asyncHandler)
AmazonQuickSightAsync
Describes the permissions of a topic.
describeTopicPermissionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTopicRefreshResult> describeTopicRefreshAsync(DescribeTopicRefreshRequest request)
AmazonQuickSightAsync
Describes the status of a topic refresh.
describeTopicRefreshAsync
in interface AmazonQuickSightAsync
public Future<DescribeTopicRefreshResult> describeTopicRefreshAsync(DescribeTopicRefreshRequest request, AsyncHandler<DescribeTopicRefreshRequest,DescribeTopicRefreshResult> asyncHandler)
AmazonQuickSightAsync
Describes the status of a topic refresh.
describeTopicRefreshAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTopicRefreshScheduleResult> describeTopicRefreshScheduleAsync(DescribeTopicRefreshScheduleRequest request)
AmazonQuickSightAsync
Deletes a topic refresh schedule.
describeTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
public Future<DescribeTopicRefreshScheduleResult> describeTopicRefreshScheduleAsync(DescribeTopicRefreshScheduleRequest request, AsyncHandler<DescribeTopicRefreshScheduleRequest,DescribeTopicRefreshScheduleResult> asyncHandler)
AmazonQuickSightAsync
Deletes a topic refresh schedule.
describeTopicRefreshScheduleAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AmazonQuickSightAsync
Returns information about a user, given the user name.
describeUserAsync
in interface AmazonQuickSightAsync
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonQuickSightAsync
Returns information about a user, given the user name.
describeUserAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeVPCConnectionResult> describeVPCConnectionAsync(DescribeVPCConnectionRequest request)
AmazonQuickSightAsync
Describes a VPC connection.
describeVPCConnectionAsync
in interface AmazonQuickSightAsync
public Future<DescribeVPCConnectionResult> describeVPCConnectionAsync(DescribeVPCConnectionRequest request, AsyncHandler<DescribeVPCConnectionRequest,DescribeVPCConnectionResult> asyncHandler)
AmazonQuickSightAsync
Describes a VPC connection.
describeVPCConnectionAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest request)
AmazonQuickSightAsync
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.
generateEmbedUrlForAnonymousUserAsync
in interface AmazonQuickSightAsync
public Future<GenerateEmbedUrlForAnonymousUserResult> generateEmbedUrlForAnonymousUserAsync(GenerateEmbedUrlForAnonymousUserRequest request, AsyncHandler<GenerateEmbedUrlForAnonymousUserRequest,GenerateEmbedUrlForAnonymousUserResult> asyncHandler)
AmazonQuickSightAsync
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.
generateEmbedUrlForAnonymousUserAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest request)
AmazonQuickSightAsync
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.
generateEmbedUrlForRegisteredUserAsync
in interface AmazonQuickSightAsync
public Future<GenerateEmbedUrlForRegisteredUserResult> generateEmbedUrlForRegisteredUserAsync(GenerateEmbedUrlForRegisteredUserRequest request, AsyncHandler<GenerateEmbedUrlForRegisteredUserRequest,GenerateEmbedUrlForRegisteredUserResult> asyncHandler)
AmazonQuickSightAsync
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.
generateEmbedUrlForRegisteredUserAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request)
AmazonQuickSightAsync
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.
getDashboardEmbedUrlAsync
in interface AmazonQuickSightAsync
public Future<GetDashboardEmbedUrlResult> getDashboardEmbedUrlAsync(GetDashboardEmbedUrlRequest request, AsyncHandler<GetDashboardEmbedUrlRequest,GetDashboardEmbedUrlResult> asyncHandler)
AmazonQuickSightAsync
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.
getDashboardEmbedUrlAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest request)
AmazonQuickSightAsync
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlAsync
in interface AmazonQuickSightAsync
public Future<GetSessionEmbedUrlResult> getSessionEmbedUrlAsync(GetSessionEmbedUrlRequest request, AsyncHandler<GetSessionEmbedUrlRequest,GetSessionEmbedUrlResult> asyncHandler)
AmazonQuickSightAsync
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with the
UpdateUser
API operation. Use
RegisterUser
API operation to add a new user with a custom permission profile attached. For more information, see the
following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest request)
AmazonQuickSightAsync
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalysesAsync
in interface AmazonQuickSightAsync
public Future<ListAnalysesResult> listAnalysesAsync(ListAnalysesRequest request, AsyncHandler<ListAnalysesRequest,ListAnalysesResult> asyncHandler)
AmazonQuickSightAsync
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalysesAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAssetBundleExportJobsResult> listAssetBundleExportJobsAsync(ListAssetBundleExportJobsRequest request)
AmazonQuickSightAsync
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.
listAssetBundleExportJobsAsync
in interface AmazonQuickSightAsync
public Future<ListAssetBundleExportJobsResult> listAssetBundleExportJobsAsync(ListAssetBundleExportJobsRequest request, AsyncHandler<ListAssetBundleExportJobsRequest,ListAssetBundleExportJobsResult> asyncHandler)
AmazonQuickSightAsync
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.
listAssetBundleExportJobsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAssetBundleImportJobsResult> listAssetBundleImportJobsAsync(ListAssetBundleImportJobsRequest request)
AmazonQuickSightAsync
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.
listAssetBundleImportJobsAsync
in interface AmazonQuickSightAsync
public Future<ListAssetBundleImportJobsResult> listAssetBundleImportJobsAsync(ListAssetBundleImportJobsRequest request, AsyncHandler<ListAssetBundleImportJobsRequest,ListAssetBundleImportJobsResult> asyncHandler)
AmazonQuickSightAsync
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.
listAssetBundleImportJobsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest request)
AmazonQuickSightAsync
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
listDashboardVersionsAsync
in interface AmazonQuickSightAsync
public Future<ListDashboardVersionsResult> listDashboardVersionsAsync(ListDashboardVersionsRequest request, AsyncHandler<ListDashboardVersionsRequest,ListDashboardVersionsResult> asyncHandler)
AmazonQuickSightAsync
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
listDashboardVersionsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request)
AmazonQuickSightAsync
Lists dashboards in an Amazon Web Services account.
listDashboardsAsync
in interface AmazonQuickSightAsync
public Future<ListDashboardsResult> listDashboardsAsync(ListDashboardsRequest request, AsyncHandler<ListDashboardsRequest,ListDashboardsResult> asyncHandler)
AmazonQuickSightAsync
Lists dashboards in an Amazon Web Services account.
listDashboardsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest request)
AmazonQuickSightAsync
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/*
.
listDataSetsAsync
in interface AmazonQuickSightAsync
public Future<ListDataSetsResult> listDataSetsAsync(ListDataSetsRequest request, AsyncHandler<ListDataSetsRequest,ListDataSetsResult> asyncHandler)
AmazonQuickSightAsync
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/*
.
listDataSetsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request)
AmazonQuickSightAsync
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSourcesAsync
in interface AmazonQuickSightAsync
public Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
AmazonQuickSightAsync
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSourcesAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest request)
AmazonQuickSightAsync
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
listFolderMembersAsync
in interface AmazonQuickSightAsync
public Future<ListFolderMembersResult> listFolderMembersAsync(ListFolderMembersRequest request, AsyncHandler<ListFolderMembersRequest,ListFolderMembersResult> asyncHandler)
AmazonQuickSightAsync
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
listFolderMembersAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListFoldersResult> listFoldersAsync(ListFoldersRequest request)
AmazonQuickSightAsync
Lists all folders in an account.
listFoldersAsync
in interface AmazonQuickSightAsync
public Future<ListFoldersResult> listFoldersAsync(ListFoldersRequest request, AsyncHandler<ListFoldersRequest,ListFoldersResult> asyncHandler)
AmazonQuickSightAsync
Lists all folders in an account.
listFoldersAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request)
AmazonQuickSightAsync
Lists member users in a group.
listGroupMembershipsAsync
in interface AmazonQuickSightAsync
public Future<ListGroupMembershipsResult> listGroupMembershipsAsync(ListGroupMembershipsRequest request, AsyncHandler<ListGroupMembershipsRequest,ListGroupMembershipsResult> asyncHandler)
AmazonQuickSightAsync
Lists member users in a group.
listGroupMembershipsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request)
AmazonQuickSightAsync
Lists all user groups in Amazon QuickSight.
listGroupsAsync
in interface AmazonQuickSightAsync
public Future<ListGroupsResult> listGroupsAsync(ListGroupsRequest request, AsyncHandler<ListGroupsRequest,ListGroupsResult> asyncHandler)
AmazonQuickSightAsync
Lists all user groups in Amazon QuickSight.
listGroupsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest request)
AmazonQuickSightAsync
Lists the IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsAsync
in interface AmazonQuickSightAsync
public Future<ListIAMPolicyAssignmentsResult> listIAMPolicyAssignmentsAsync(ListIAMPolicyAssignmentsRequest request, AsyncHandler<ListIAMPolicyAssignmentsRequest,ListIAMPolicyAssignmentsResult> asyncHandler)
AmazonQuickSightAsync
Lists the IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignmentsAsync
in interface AmazonQuickSightAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest request)
AmazonQuickSightAsync
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.
listIAMPolicyAssignmentsForUserAsync
in interface AmazonQuickSightAsync
public Future<ListIAMPolicyAssignmentsForUserResult> listIAMPolicyAssignmentsForUserAsync(ListIAMPolicyAssignmentsForUserRequest request, AsyncHandler<ListIAMPolicyAssignmentsForUserRequest,ListIAMPolicyAssignmentsForUserResult> asyncHandler)
AmazonQuickSightAsync
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.
listIAMPolicyAssignmentsForUserAsync
in interface AmazonQuickSightAsync
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.